From 71e902ca8509281180e23d4086df69b7232ab3ed Mon Sep 17 00:00:00 2001 From: fa-ui-bot Date: Fri, 23 Jan 2026 10:48:15 +0000 Subject: [PATCH] Adding FB2.23 --- definitions/oas3.x/FB2.23.spec.yaml | 33588 ++++++++++++++++++++++ html/spec_index.yaml | 6 + html/specs/FB2.23.spec.yaml | 39437 ++++++++++++++++++++++++++ 3 files changed, 73031 insertions(+) create mode 100644 definitions/oas3.x/FB2.23.spec.yaml create mode 100644 html/specs/FB2.23.spec.yaml diff --git a/definitions/oas3.x/FB2.23.spec.yaml b/definitions/oas3.x/FB2.23.spec.yaml new file mode 100644 index 0000000..9f652df --- /dev/null +++ b/definitions/oas3.x/FB2.23.spec.yaml @@ -0,0 +1,33588 @@ +openapi: 3.0.1 +info: + title: FlashBlade REST API + description: | + A lightweight client for FlashBlade REST API 2.20, developed by + Pure Storage, Inc. (http://www.purestorage.com/). + version: "2.23" + x-pure-description-ref: ../custom_descriptions/FB-api-introduction.md + x-logo: + url: + $ref: ../redoc/PS-LogoBase64-FA.txt +servers: +- url: "http://[array]/" +- url: "https://[array]/" +security: +- AuthorizationHeader: [] +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 joins a server to the domain and manages its computer account. + Authentication for NFS or SMB is performed using Kerberos. This configuration is also used to authorize + users by mapping identities across the NFS and SMB protocols by using LDAP queries. +- name: Administrators + description: "Manage administrators, including their REST API Token and public key for SSH access. The + array has a single default administrative account named `pureuser`. Additional administrators and + their administrative roles can be added by configuring the `management` directory service for the + array or by creating local administrative users. The available administrative roles are `array_admin`, + `storage_admin`,`readonly`, `ops_admin`." +- name: Alerts + description: "Alerts indicate significant events that occur on the 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: Arrays + description: "Arrays features provide the ability to configure settings that affect the array as a whole, + monitor array I/O performance, and make sure that the array is operating properly." +- name: Array Connections + description: "View and manage connected arrays, including their network configurations, connection keys, + and replication performance." +- name: Audits + description: "View the audit trail on the array. Every request that creates, modifies, or deletes a + resource will be logged in the audit trail." +- name: Blades + description: Displays the detailed information of each blade in the array. +- name: Buckets + description: "Manages the creation, attributes, and deletion of buckets on the array." +- name: Bucket Replica Links + description: "Object replication requires a replica link that connects a source bucket to a remote bucket. + The configuration of a replica link includes remote credentials, bucket names, remote names, replication + status information, and cascading state." +- name: Certificates + description: "Purity//FB 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 can contain one or more CA certificates for verifying an LDAP server + identity and establish communication over TLS. +- name: Clients + description: "Displays an NFS client’s performance metrics on the array for read, write, and meta operations." +- 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: DNS + description: "Manages the Domain Name System (DNS) attributes, including the domain suffix and static + name servers. The configured attributes can be listed." +- name: Drives + description: "Displays detailed information for each drive in the array. Drives are not used in all + hardware platforms, and are currently only present in the FlashBlade//S and FlashBlade//E product + lines." +- name: File Systems + description: "Manages the creation, attributes, and deletion of file systems on the array." +- name: File System Exports + description: "Manages the creation, attributes, and deletion of file system exports. Exports link either + an NFS Export Policy or a SMB Client Policy, a file system, and a server." +- name: File System Replica Links + description: "File system replication requires a replica link that connects a source array to a remote + target. The configuration of a replica link includes policies, file system names, remote names, and + replication status information." +- name: File System Snapshots + description: "A file system snapshot is a point-in-time copy of a file system. Multiple snapshots of + a file system can be copied for different points in time. A snapshot policy can also be applied to + a file system for automatic creation and retention of snapshots. Additionally, file system snapshots + can also be sent from one array to another." +- name: Fleets + description: "A fleet is a collection of Regions, Availability Zones, and Arrays." +- name: Hardware + description: Manages hardware components. List information about array hardware components that are + capable of reporting their status. The display is primarily useful for diagnosing hardware-related + problems. +- name: Hardware Connectors + description: | + The endpoints are deprecated. Use the endpoints under Network Interfaces instead. + Manages the port connector attributes on the array. Lane speeds + and port count attributes can be configured. +- name: Keytabs + description: Keytab management functionality for Kerberos authentication. +- name: KMIP + description: Manages KMIP server configurations and performs connectivity and functionality tests. +- name: Legal Holds + description: "Manages the creation, attributes, and deletion of holds on the array. A hold can be also + applied to a path under a file system to mark the entries under the path as immutable." +- 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: Link Aggregation Groups + description: Manages the link aggregation group (LAG) of Ethernet ports on the array. +- name: Logs + description: The array collects a log of command activities that can be used for analysis when the logs + are sent to Pure Technical Services. +- name: Maintenance Windows + description: | + During a maintenance window, many alerts are suppressed that are related to connections, + paths, ports, and other resources that are down during maintenance. +- name: Network Interfaces + description: "Manages the interface, network connection, and port connector attributes of the array. + Lane speeds and port count connector attributes can be configured." +- name: Nodes + description: Manages the nodes for pNFS. These nodes are where the client will read/write to when pNFS + is enabled. +- name: Node Groups + description: Node Groups can contain one or more nodes for file system creation management. +- 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 Account Exports + description: Manages object store account exports. Exports expose accounts and their contained resources + to servers. +- name: Object Store Remote Credentials + description: Manages remote credentials for remote objects. Remote credentials contain access information + that can be reused for multiple objects. +- name: Object Store Roles + description: Manages the roles assumable by external federated entity. Each role is assigned a trust + policy that determines which identity provider authorizes the entities and how. +- 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: OIDC SSO + description: | + OIDC SSO allows customers to configure settings of OIDC service provider + and identity provider. It provides a multi-factor authentication (MFA) + mechanism for customers to log in to FlashBlade. +- name: Policies (All) + description: Displays general information for all available types of policies and their members. +- name: Policies - Audit for File Systems + description: Manages audit policies for filesystems. These policies are composed of log target rules + which contain the destination for audit logs. +- name: Policies - Data Eviction + description: Manages file Data Eviction policies. These policies define controls that can be configured + and attached to managed data lifecycle independently of the lifecycle of files. +- name: Policies - Management Access + description: Manages management access policies. These policies are composed of rules which govern an + administrative user's permissions when managing resources. +- name: Policies - Management Authentication + description: Manages management authentication policies. These policies control what authentication + factors are required when logging in to different management interfaces (e.g., SSH). +- name: Policies - Network Access + description: Manages network access policies. These policies are composed of rules which govern a client's + ability to access different product interfaces. +- name: Policies - NFS + description: Manages NFS export policies. These policies are composed of rules which govern a client's + ability to access the exported filesystem. +- name: Policies - Object Store Access + description: Manages access policies for object store users. Administrators can assign policies to users + for managing buckets and objects. +- name: Policies - Password + description: Manages password policies. These policies define requirements for user passwords complexity + and login attempts. +- name: Policies - QoS + description: Manages Quality of Service (QoS) policies. These policies define controls that can be configured + and attached to managed objects to guarantee performance of workloads. +- name: Policies - S3 Export + description: | + Manages S3 export policies for Object Store Account Exports. These policies contain rules which + govern which buckets from the account are actually exported to the servers. +- name: Policies - SMB Client + description: An SMB Client policy manages access to SMB file systems on a per-client basis. These policies + can be applied to one or more file systems. +- name: Policies - SMB Share + description: An SMB Share policy manages access to SMB file systems on a per-user/group basis. These + policies can be applied to one or more file systems. +- name: Policies - Snapshot + description: "A snapshot policy manages the creation file system snapshots or it can applied to file + system and object replication links for replication. These policies provide the user a way to control + the frequency of creating snapshots and objects, and the retention time for each copy. A snapshot + policy can be applied to one or more file systems, objects, or replication links." +- name: Policies - SSH Certificate Authority + description: "An SSH Certificate Authority policy manages the keys that are allowed to sign user SSH + certificates for access to the array, as well as the principals that they require be encoded in certificates + to authenticate. These policies can be applied to one or more users, or as a default for all users." +- name: Policies - Storage Class Tiering + description: A storage class tiering policy manages the criteria for tiering data within a filesystem + from one storage class to another. These policies can be applied to one or more filesystems. Supported + storage classes are `S500X-S` for speed, and `S500X-A` for archival. +- name: Policies - TLS + description: "A TLS policy manages the allowed TLS versions and ciphers for incoming network traffic + to the system. These policies can be applied at the array level, or to individual network IPs." +- name: Policies - WORM Data + description: "Manages WORM data for file systems. These policies are composed of retention periods, + lock type, and auto-commit status." +- name: Presets + description: | + Presets are reusable templates that provision resources. +- name: Public Keys + description: Public Keys can be configured for reference in other configurations as signing keys are + used to verify cryptographic signatures. +- name: Quotas + description: A quota manages a set amount of space on a file system which a user or group may write + to. A quota can be applied to a user or group of a specified file system. Once a user or group reaches + their quota they will no longer be able to write to that file system. +- name: Realms + description: | + A realm provides a means to compartmentalize storage resources, + access, and isolate administration of all contained resources. +- name: Remote Arrays + description: | + Remote arrays provide the ability to list and manage all the remote arrays known to an array. +- name: Resiliency Groups + description: | + Resiliency groups display pairs of nodes where HA is enabled. +- name: Resource Accesses + description: | + Resource Access captures sharing of a resource to a scope, e.g. sharing a dns to a realm. +- name: RDL + description: Displays Rapid Data Locking (RDL) configuration and performs functionality tests of the + associated Enterprise Key Management (EKM) servers. +- name: Roles + description: "Displays role attributes. Each user of the array is assigned to a role and each role has + a set of role based access controls (RBAC). The roles (`array_admin`, `storage_admin`, `ops_admin`, + `readonly`, and `Invalid - multiple roles`) have a specified set of permissions that allow certain + actions to be performed on the array. Each role includes a listing REST actions allowable for each + endpoint." +- 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 FlashBlade. +- name: Servers + description: Manages the properties of servers. Servers are network and identity management access points + for data. +- name: Sessions + description: Displays Purity//FB login and user session data. +- 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 the Simple Network Management Protocol (SNMP) agents and displays the Management + Information Base (MIB) file. The SNMP agent sends array component status information and alerts to + the SNMP manager. The MIB file lists all manageable modules of the array. +- name: SNMP Managers + description: "Manages the Simple Network Management Protocol (SNMP) managers, including performing functionality + tests. The SNMP manager receives array component status information and alerts from the SNMP agent." +- 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: Support + description: "Manages support configurations for the array, including performing functionality tests. + The remote assist and phone home feature provides supplement information to Pure Technical Services + to assist with customer issues." +- name: Support Diagnostics + description: "Manages support diagnostics for the array, including performing diagnostics tasks, running + tests, finding problems and giving remediation. The diagnostics tool provides a way to test the array + components and generate a report of the results." +- name: Syslog + description: "Manages syslog servers connected to the array, including performing functionality tests + of syslog servers." +- name: Targets + description: "Manages targets for replication, including viewing the performance metrics of active replication + operations." +- name: Trust Policies + description: Manages policies that control assuming Object Store Roles by external federated entities + via Identity Providers +- name: Usage + description: Displays the data usage and hard limit quotas for all users and groups on a file system. +- name: Verification Keys + description: Verification keys used by Pure Support to access the array. +- 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: 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: GET api_version + description: | + Get available API versions. No authentication is required to access this endpoint. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Api_version' + security: [] + /api/login: + post: + tags: + - Authorization + summary: POST login + description: | + Exchange an API token for a REST session token. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + x-auth-token: + description: REST session token for a user. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Login' + security: + - ApiToken: [] + /api/logout: + post: + tags: + - Authorization + summary: POST logout + description: | + Invalidate a REST session token. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/login-banner: + get: + tags: + - Authorization + summary: GET login_banner + description: | + Get the login banner for the array. No authentication is required to access this endpoint. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/LoginBannerGetResponse' + security: [] + /api/2.23/active-directory: + get: + tags: + - Active Directory + summary: GET active-directory + description: List Active Directory accounts and their configuration. + parameters: + - $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' + 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/ActiveDirectoryGetResponse' + post: + tags: + - Active Directory + summary: POST active-directory + description: | + Join an Active Directory domain and generate keytabs for the + registered SPNs and supported encryption types. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Join_existing_acct_ad' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ActiveDirectoryPost' + required: true + x-codegen-request-body-name: active-directory + 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/ActiveDirectoryResponse' + x-codegen-request-body-name: active-directory + delete: + tags: + - Active Directory + summary: DELETE active-directory + description: Delete an Active Directory account. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_only_ad' + - $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: + - Active Directory + summary: PATCH active-directory + description: Modify the configuration of an Active Directory account. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ActiveDirectoryPatch' + required: true + x-codegen-request-body-name: active-directory + 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/ActiveDirectoryResponse' + x-codegen-request-body-name: active-directory + /api/2.23/active-directory/test: + get: + tags: + - Active Directory + summary: GET active-directory/test + description: > + Executes a series of tests to verify if the configuration of one or more Active Directory accounts + are functioning properly. Each test verifies a different aspect of the configuration. + 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/Sort' + 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/TestResultRemoteExecutionGet' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TestResultRemoteExecutionGet' + /api/2.23/admins: + get: + tags: + - Administrators + summary: GET admins + description: "List the administrator's attributes, including the API token and public key." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Expose_api_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' + 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/AdminGetResponse' + post: + tags: + - Administrators + summary: POST admins + description: Create a new local administrator. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AdminResponse' + x-codegen-request-body-name: admin + delete: + tags: + - Administrators + summary: DELETE admins + description: Delete a local administrator.. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Administrators + summary: PATCH admins + description: Modify the attributes of an administrator. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AdminResponse' + x-codegen-request-body-name: admin + /api/2.23/admins/api-tokens: + get: + tags: + - Administrators + summary: GET admins/api-tokens + description: Displays API tokens for the specified administrators. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Admin_ids' + - $ref: '#/components/parameters/Admin_names' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Expose_api_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/AdminApiTokenGetResponse' + post: + tags: + - Administrators + summary: POST admins/api-tokens + description: Creates API tokens for the specified administrators. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Admin_ids' + - $ref: '#/components/parameters/Admin_names' + - $ref: '#/components/parameters/Timeout' + 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/AdminApiTokenResponse' + delete: + tags: + - Administrators + summary: DELETE admins/api-tokens + description: Deletes the API tokens of the specified administrators. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Admin_ids' + - $ref: '#/components/parameters/Admin_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.23/admins/cache: + get: + tags: + - Administrators + summary: GET admins/cache + description: List cached administrator information used to determine role based access control privileges. + parameters: + - $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/Refresh' + - $ref: '#/components/parameters/Sort' + 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/AdminCacheGetResponse' + delete: + tags: + - Administrators + summary: DELETE admins/cache + description: Delete cached administrator role information by name or ID. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/admins/management-access-policies: + get: + tags: + - Policies - Management Access + summary: GET admins/management-access-policies + description: | + List management access policies mapped to admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - Management Access + summary: POST admins/management-access-policies + description: Map an admin to a management access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - Management Access + summary: DELETE admins/management-access-policies + description: Remove the mapping of an admin to a management access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/admins/management-authentication-policies: + get: + tags: + - Policies - Management Authentication + summary: GET admins/management-authentication-policies + description: List the members mapped to management authentication 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' + 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/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Management Authentication + summary: POST admins/management-authentication-policies + description: Map a member to a management authentication 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: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextResponse' + delete: + tags: + - Policies - Management Authentication + summary: DELETE admins/management-authentication-policies + description: Remove the management authentication policy mapped to a member. + 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.23/admins/settings: + get: + tags: + - Administrators + summary: List global admin settings + description: Return global admin settings. + parameters: + - $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' + 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/AdminSettingsGetResponse' + patch: + tags: + - Administrators + summary: Update global admin settings + description: Update properties for global admin settings. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSetting' + required: true + x-codegen-request-body-name: admin-setting + 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/AdminSettingsResponse' + x-codegen-request-body-name: admin-setting + /api/2.23/admins/ssh-certificate-authority-policies: + get: + tags: + - Policies - SSH Certificate Authority + summary: GET admins/ssh-certificate-authority-policies + description: List SSH Certificate Authority policies mapped to specific users. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - SSH Certificate Authority + summary: POST admins/ssh-certificate-authority-policies + description: Map a SSH Certificate Authority policy to a specific user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - SSH Certificate Authority + summary: DELETE admins/ssh-certificate-authority-policies + description: Remove a SSH Certificate Authority policy from a specific user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/alerts: + get: + tags: + - Alerts + summary: GET alerts + description: |+ + Returns a list of alerts which have been generated by the array. + + parameters: + - $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' + 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/AlertGetResponse' + patch: + tags: + - Alerts + summary: PATCH alerts + description: |+ + Make changes to an alert. This is currently limited to the alert's `flagged` property. + + parameters: + - $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: alerts-settings + 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/AlertResponse' + x-codegen-request-body-name: alerts-settings + /api/2.23/alert-watchers: + get: + tags: + - Alert Watchers + summary: GET alert-watchers + description: List alert watchers that are configured to receive alert messages. + parameters: + - $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' + 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/AlertWatcherGetResponse' + post: + tags: + - Alert Watchers + summary: POST alert-watchers + description: Create an alert watcher to receive array alert messages. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AlertWatcherResponse' + x-codegen-request-body-name: alert-watcher + delete: + tags: + - Alert Watchers + summary: DELETE alert-watchers + description: Delete an alert watcher. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Alert Watchers + summary: PATCH alert-watchers + description: "Modify an alert watcher’s configuration. Enable or disable an alert watcher privilege + and select the level of alert notification of an alert watcher. Alert notification levels are + `info`, `warning`, or `critical`." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AlertWatcher' + required: true + x-codegen-request-body-name: alert-watcher + 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/AlertWatcherResponse' + x-codegen-request-body-name: alert-watcher + /api/2.23/alert-watchers/test: + get: + tags: + - Alert Watchers + summary: GET alert-watchers/test + description: Test an alert watcher's contact information to verify alerts can be sent and received. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + 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/TestResultResponse' + /api/2.23/api-clients: + get: + tags: + - API Clients + summary: GET api-clients + description: List an API client and its configuration attributes. + parameters: + - $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' + responses: + "200": + description: | + Returns a list of API clients. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClientsResponse' + post: + tags: + - API Clients + summary: POST api-clients + description: "Create an API client to authorize Access Token or Bearer Tokens for use on the array. + Required fields include `issuer`, `public_key`, and `access_token_ttl_in_ms`. After creating an + API client, it can only be enabled by an authorized user." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClientsPost' + required: true + x-codegen-request-body-name: api-client + responses: + "200": + description: | + Returns the new api-clients. All new api-clients are disabled. + An authorized party must patch the api-clients to be enabled, which signifies + the api-clients are now trusted and authorized to issue id tokens for this + array. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClientsResponse' + x-codegen-request-body-name: api-client + delete: + tags: + - API Clients + summary: DELETE api-clients + description: Delete the API client. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - API Clients + summary: PATCH api-clients + description: Modify an API client. Newly created API clients can be enabled by setting the `enabled` + parameter to `true`. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClient' + required: true + x-codegen-request-body-name: api-clients + responses: + "200": + description: Returns the patched api-clients. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClientsResponse' + x-codegen-request-body-name: api-clients + /api/2.23/arrays: + get: + tags: + - Arrays + summary: GET arrays + description: "List array attributes such as the array name, ID, version, and NTP servers." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayGetResponse' + patch: + tags: + - Arrays + summary: PATCH arrays + description: "Modify the general configuration of the array including banner text, array name, NTP + servers, and time zone." + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Array' + required: true + x-codegen-request-body-name: array + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayResponse' + x-codegen-request-body-name: array + /api/2.23/arrays/clients/performance: + get: + tags: + - Clients + summary: GET clients-performance + description: List client performance metrics. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Protocol_clients' + - $ref: '#/components/parameters/Sort' + - $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/ClientsPerformanceGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ClientsPerformanceGetResponse' + /api/2.23/arrays/clients/s3-specific-performance: + get: + tags: + - Clients + summary: GET clients-performance + description: List S3 client performance performance metrics. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + - $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/ClientsS3SpecificPerformanceGetResponse' + /api/2.23/arrays/eula: + get: + tags: + - Arrays + summary: GET arrays/eula + description: List the End User Agreement and signature. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/EulaGetResponse' + patch: + tags: + - Arrays + summary: PATCH arrays/eula + description: Modifies the signature on the End User Agreement. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Eula' + required: false + x-codegen-request-body-name: eula + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/EulaResponse' + x-codegen-request-body-name: eula + /api/2.23/arrays/factory-reset-token: + get: + tags: + - Arrays + summary: List factory reset tokens + description: Displays a list of tokens used to perform a factory reset on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayFactoryResetTokenGetResponse' + post: + tags: + - Arrays + summary: Create a factory reset token + description: | + Creates a token that can be used to perform a factory reset on the array. + Factory reset tokens can only be created after the array has been prepared + for reset (e.g., all file systems, buckets, and snapshots must first be eradicated). + After a token has been created, operations that would take the array out of + the prepared state (e.g., creating file systems) are disabled until all + tokens have been deleted. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayFactoryResetTokenResponse' + delete: + tags: + - Arrays + summary: Delete a factory reset token + description: | + Deletes any existing token that could be used to perform a factory reset on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/arrays/management-authentication-policies: + get: + tags: + - Policies - Management Authentication + summary: GET arrays/management-authentication-policies + description: List management authentication policies mapped as default for admins. + 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' + 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/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Management Authentication + summary: POST arrays/management-authentication-policies + description: Map a management authentication policy as default for admins. + 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/PolicyMemberContextResponse' + delete: + tags: + - Policies - Management Authentication + summary: DELETE arrays/management-authentication-policies + description: Remove a management authentication policy from being a default for admins. + 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.23/arrays/ssh-certificate-authority-policies: + get: + tags: + - Policies - SSH Certificate Authority + summary: GET admins/settings/ssh-certificate-authority-policies + description: List SSH Certificate Authority policies mapped as defaults for admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - SSH Certificate Authority + summary: POST admins/settings/ssh-certificate-authority-policies + description: Map a SSH Certificate Authority policy as a default for admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - SSH Certificate Authority + summary: DELETE admins/settings/ssh-certificate-authority-policies + description: Remove a SSH Certificate Authority policy from being a default for admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/array-connections: + get: + tags: + - Array Connections + summary: GET array-connections + description: List connected arrays for replication. + 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/Offset' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + 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/ArrayConnectionGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayConnectionGetResponse' + post: + tags: + - Array Connections + summary: POST array-connections + description: Create a connection to an array for replication and configure network settings. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayConnectionResponse' + x-codegen-request-body-name: array-connection + delete: + tags: + - Array Connections + summary: DELETE array-connections + description: Delete a connection to an array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Remote_ids_deprecated' + - $ref: '#/components/parameters/Remote_names_deprecated' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Array Connections + summary: PATCH array-connections + description: Modify the configuration of a connected array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Remote_ids_deprecated' + - $ref: '#/components/parameters/Remote_names_deprecated' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayConnection' + required: true + x-codegen-request-body-name: array-connection + 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/ArrayConnectionResponse' + x-codegen-request-body-name: array-connection + /api/2.23/array-connections/connection-key: + get: + tags: + - Array Connections + summary: GET array-connections/connection-key + description: List connection keys used to authenticate the connection from one array to another. + parameters: + - $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' + 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/ArrayConnectionKeyGetResponse' + post: + tags: + - Array Connections + summary: POST array-connections/connection-key + description: Create an array connection key allowing one array to connect to another for replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayConnectionKeyResponse' + /api/2.23/array-connections/path: + get: + tags: + - Array Connections + summary: GET array-connections/path + description: List network path details of connected arrays. + 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/Offset' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + 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/ArrayConnectionPathGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayConnectionPathGetResponse' + /api/2.23/array-connections/performance/replication: + get: + tags: + - Array Connections + summary: GET array-connections/performance/replication + description: List performance metrics of file systems or objects being replicated from one array + to another. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/Total_only' + - $ref: '#/components/parameters/Type_for_performance' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectionRelationshipPerformanceReplicationGetResp' + /api/2.23/arrays/http-specific-performance: + get: + tags: + - Arrays + summary: GET arrays/http-specific-performance + description: List the HTTP performance metrics of the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayHttpSpecificPerformanceGet' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayHttpSpecificPerformanceGet' + /api/2.23/arrays/nfs-specific-performance: + get: + tags: + - Arrays + summary: GET arrays/nfs-specific-performance + description: List the NFS performance metrics of the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayNfsSpecificPerformanceGet' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayNfsSpecificPerformanceGet' + /api/2.23/arrays/performance: + get: + tags: + - Arrays + summary: GET arrays/performance + description: Lists the overall performance metrics of the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Protocol' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayPerformanceGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayPerformanceGetResponse' + /api/2.23/arrays/performance/replication: + get: + tags: + - Arrays + summary: GET arrays/performance/replication + description: List replication performance metrics. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/Type_for_performance' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayPerformanceReplicationGetResp' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayPerformanceReplicationGetResp' + /api/2.23/arrays/s3-specific-performance: + get: + tags: + - Arrays + summary: GET arrays/s3-specific-performance + description: List the S3 performance metrics of the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayS3SpecificPerformanceGetResp' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayS3SpecificPerformanceGetResp' + /api/2.23/arrays/space: + get: + tags: + - Arrays + summary: GET arrays/space + description: List available and used storage space on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/Type' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArraySpaceGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArraySpaceGetResponse' + /api/2.23/arrays/space/storage-classes: + get: + tags: + - Arrays + summary: GET arrays/space/storage-classes + description: List available and used storage space for storage classes on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/StorageClassNames' + - $ref: '#/components/parameters/Total_only' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArraySpaceStorageClassGetResponse' + /api/2.23/arrays/supported-time-zones: + get: + tags: + - Arrays + summary: GET arrays/supported-time-zones + description: List supported time zones for the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArraysSupportedTimeZonesGetResponse' + /api/2.23/arrays/erasures: + post: + summary: Create a process for factory reset + description: |+ + Creates the initiation of the factory reset process. + + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Eradicate_all_data_required' + - $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' + + tags: + - Arrays + + patch: + summary: Factory reset - finalize + description: |+ + After the process has been completed, we need to finalize the factory reset process. + + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Delete_sanitization_certificate_required' + - $ref: '#/components/parameters/Eradicate_all_data_required' + - $ref: '#/components/parameters/Finalize_array_erasure_required' + + responses: + 200: + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayErasureResponse' + + tags: + - Arrays + + + get: + summary: Get factory reset status + description: | + Get the factory reset process status. + parameters: + - $ref: '#/components/parameters/XRequestId' + + responses: + 200: + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayErasureGetResponse' + + tags: + - Arrays + + + delete: + summary: Stop factory reset + description: |+ + Stops the factory reset process when it is `failed`. + + parameters: + - $ref: '#/components/parameters/XRequestId' + + responses: + 200: + description: OK + + tags: + - Arrays + /api/2.23/audits: + get: + tags: + - Audits + summary: GET audits + description: List the array audit trail to view activities that were performed on the array. + parameters: + - $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' + 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/AuditGetResponse' + /api/2.23/audit-file-systems-policies: + get: + tags: + - Policies - Audit for File Systems + summary: GET audit-file-systems-policies + description: Displays a list of audit policies for file systems. + 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' + 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/AuditFileSystemsPoliciesGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AuditFileSystemsPoliciesGetResponse' + post: + tags: + - Policies - Audit for File Systems + summary: POST audit-file-systems-policies + description: Create a new audit policy for file systems. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuditFileSystemsPoliciesPost' + required: false + x-codegen-request-body-name: policy + 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/AuditFileSystemsPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Audit for File Systems + summary: DELETE audit-file-systems-policies + description: Delete one or more audit policies. + 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: + - Policies - Audit for File Systems + summary: PATCH audit-file-systems-policies + description: Modify an existing audit policy's attributes. + 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/AuditFileSystemsPoliciesPatch' + required: true + x-codegen-request-body-name: policy + 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/AuditFileSystemsPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/audit-file-systems-policies/members: + get: + tags: + - Policies - Audit for File Systems + summary: GET audit-file-systems-policies/members + description: List file systems mapped to a audit policy. + 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' + 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/AuditFileSystemsPoliciesMembersGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AuditFileSystemsPoliciesMembersGetResponse' + post: + tags: + - Policies - Audit for File Systems + summary: POST audit-file-systems-policies/members + description: Map a file system to a audit 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: + application/json: + schema: + $ref: '#/components/schemas/AuditFileSystemsPoliciesMembersResponse' + delete: + tags: + - Policies - Audit for File Systems + summary: DELETE audit-file-systems-policies/members + description: Remove the audit policy mapped to a file system. + 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.23/audit-file-systems-policy-operations: + get: + tags: + - Policies - Audit for File Systems + summary: GET audit-file-systems-policy-operations + description: |+ + List of valid strings for audit policy rules for file systems. + Each string is either a valid operation or our custom group of operations (`ReadOnly`, `WriteOnly`). + Each of the operations, when included in a rule, will audit the operation on the file system. + + 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' + 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/AuditFileSystemsPolicyOperationGetResponse' + /api/2.23/audit-object-store-policies: + get: + tags: + - Policies - Audit for Object Store + summary: GET audit-object-store-policies + description: Displays a list of audit policies for objects. + 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' + 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/AuditObjectStorePoliciesGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AuditObjectStorePoliciesGetResponse' + post: + tags: + - Policies - Audit for Object Store + summary: POST audit-object-store-policies + description: Create a new audit policy for objects. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuditObjectStorePoliciesPost' + required: false + x-codegen-request-body-name: policy + 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/AuditObjectStorePoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Audit for Object Store + summary: DELETE audit-object-store-policies + description: Delete one or more audit policies. + 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: + - Policies - Audit for Object Store + summary: PATCH audit-object-store-policies + description: Modify an existing audit policy's attributes. + 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/AuditObjectStorePoliciesPatch' + required: true + x-codegen-request-body-name: policy + 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/AuditObjectStorePoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/audit-object-store-policies/members: + get: + tags: + - Policies - Audit for Object Store + summary: GET audit-object-store-policies/members + description: List source(bucket/account) mapped to an audit object policy. + 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' + 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/AuditObjectStorePoliciesMembersGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AuditObjectStorePoliciesMembersGetResponse' + post: + tags: + - Policies - Audit for Object Store + summary: POST audit-object-store-policies/members + description: Map a source(bucket/account) to an audit object 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: + application/json: + schema: + $ref: '#/components/schemas/AuditObjectStorePoliciesMembersResponse' + delete: + tags: + - Policies - Audit for Object Store + summary: DELETE audit-object-store-policies/members + description: Remove the audit object policy mapped to a source(bucket/account). + 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.23/blades: + get: + tags: + - Blades + summary: GET blades + description: List array blade information. + parameters: + - $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_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/BladeGetResponse' + /api/2.23/bucket-audit-filter-actions: + get: + tags: + - Buckets + summary: GET bucket-audit-filter-actions + description: |+ + List valid actions for bucket audit filter. Each action is either a valid + AWS S3 action (prefixed by `s3:`), special wildcard action (`s3:*`), or our + custom group of actions (`s3:ReadOnly`, `s3:WriteOnly`). Each action, when + included in a rule, may audit the action on the bucket. + + 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' + 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/BucketAuditFilterActionGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAuditFilterActionGetResponse' + /api/2.23/buckets: + get: + tags: + - Buckets + summary: 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_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. + 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' + post: + tags: + - Buckets + summary: 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/BucketPost' + 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: 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: PATCH buckets + description: Modify object store bucket attributes such as destroyed and versioning. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Cancel_storage_class_transition' + - $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/BucketPatch' + 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.23/buckets/audit-filters: + get: + tags: + - Buckets + summary: GET buckets/audit-filters + description: | + List audit filters associated with the specified bucket. + 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/BucketAuditFilterGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAuditFilterGetResponse' + post: + tags: + - Buckets + summary: POST buckets/audit-filters + description: | + Create a new audit filter for the specified bucket. + `names` query parameter is required. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAuditFilterPost' + required: true + x-codegen-request-body-name: audit filter + 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/BucketAuditFilterResponse' + x-codegen-request-body-name: audit filter + delete: + tags: + - Buckets + summary: DELETE buckets/audit-filters + description: | + Delete one or more audit filters associated with the specified bucket. + `names` query parameter is required. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $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: PATCH buckets/audit-filters + description: | + Modify the audit filter associated with the specified bucket. + `names` query parameter is required. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAuditFilterPost' + required: true + x-codegen-request-body-name: audit filter + 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/BucketAuditFilterResponse' + x-codegen-request-body-name: audit filter + /api/2.23/buckets/cross-origin-resource-sharing-policies: + get: + tags: + - Buckets + summary: GET buckets/cross-origin-resource-sharing-policies + description: | + List cross origin resource sharing policy for the specified bucket and its attributes. + Either `names` or `bucket_names`/`bucket_ids` query parameters can be used. + 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/CrossOriginResourceSharingPolicyGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyGetResponse' + post: + tags: + - Buckets + summary: POST buckets/cross-origin-resource-sharing-policies + description: | + Create a new cross origin resource sharing policy for the specified bucket. + Policy's name will be autogenerated by the system. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyPatch' + required: false + x-codegen-request-body-name: policy + 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/CrossOriginResourceSharingPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Buckets + summary: DELETE buckets/cross-origin-resource-sharing-policies + description: | + Delete a cross origin resource sharing policy of the specified bucket. + Either `names` or `bucket_names`/`bucket_ids` query parameters can be used. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $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.23/buckets/cross-origin-resource-sharing-policies/rules: + get: + tags: + - Buckets + summary: GET buckets/cross-origin-resource-sharing-policies/rules + description: | + List cross origin resource sharing policy rules for the specified bucket and their attributes. + Either `policy_names` or `bucket_names` query parameters can be used. + 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/CrossOriginResourceSharingPolicyRuleGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleGetResponse' + post: + tags: + - Buckets + summary: POST buckets/cross-origin-resource-sharing-policies/rules + description: | + Create a new cross origin resource sharing policy rule for the specified bucket. + Either `policy_names` or `bucket_names` query parameters can be used. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRulePost' + 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/CrossOriginResourceSharingPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Buckets + summary: DELETE buckets/cross-origin-resource-sharing-policies/rules + description: | + Delete one or more cross origin resource sharing policy rules for the specified bucket. + Either `policy_names` or `bucket_names` query parameters can be used. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names' + - $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.23/buckets/performance: + get: + tags: + - Buckets + summary: GET buckets/performance + description: List performance metrics for a bucket. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/BucketPerformanceGetResponse' + /api/2.23/buckets/bucket-access-policies: + get: + tags: + - Buckets + summary: GET buckets/bucket-access-policies + description: | + List a policy for the specified bucket and its attributes. Either `names` or + `bucket_names`/`bucket_ids` query parameters can be used. + 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/BucketAccessPolicyGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessPolicyGetResponse' + post: + tags: + - Buckets + summary: POST buckets/bucket-access-policies + description: | + Create a new policy for the specified bucket. Policy's name will be autogenerated + by the system. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessPolicyPost' + required: false + x-codegen-request-body-name: policy + 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/BucketAccessPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Buckets + summary: DELETE buckets/bucket-access-policies + description: | + Delete a bucket policy of the specified bucket. Either `names` or `bucket_names`/`bucket_ids` + query parameters can be used. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $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.23/buckets/bucket-access-policies/rules: + get: + tags: + - Buckets + summary: GET buckets/bucket-access-policies/rules + description: | + List bucket policy rules for the specified bucket and their attributes. Either `policy_names` + or `bucket_names`/`bucket_ids` query parameters can be used. + 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/BucketAccessPolicyRuleGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessPolicyRuleGetResponse' + post: + tags: + - Buckets + summary: POST buckets/bucket-access-policies/rules + description: | + Create a new bucket policy rule for the specified bucket. Either `policy_names` + or `bucket_names`/`bucket_ids` query parameters can be used. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessPolicyRulePost' + 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/BucketAccessPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Buckets + summary: DELETE buckets/bucket-access-policies/rules + description: | + Delete one or more bucket policy rules for the specified bucket. Either `policy_names` + or `bucket_names`/`bucket_ids` query parameters can be used. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names' + - $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.23/buckets/s3-specific-performance: + get: + tags: + - Buckets + summary: GET buckets/s3-specific-performance + description: List performance metrics specific to S3 operations for a bucket. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/BucketS3SpecificPerformanceGetResp' + /api/2.23/bucket-replica-links: + get: + tags: + - Bucket Replica Links + summary: GET bucket-replica-links + description: List bucket replica links for object replication. + 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/Local_bucket_ids' + - $ref: '#/components/parameters/Local_bucket_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Remote_bucket_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + - $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/BucketReplicaLinkGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BucketReplicaLinkGetResponse' + post: + tags: + - Bucket Replica Links + summary: POST bucket-replica-links + description: Create a bucket replica link for object replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Local_bucket_ids' + - $ref: '#/components/parameters/Local_bucket_names' + - $ref: '#/components/parameters/Remote_bucket_names' + - $ref: '#/components/parameters/Remote_credentials_ids' + - $ref: '#/components/parameters/Remote_credentials_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketReplicaLinkPost' + required: true + x-codegen-request-body-name: bucket-replica-link + 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/BucketReplicaLinkResponse' + x-codegen-request-body-name: bucket-replica-link + delete: + tags: + - Bucket Replica Links + summary: DELETE bucket-replica-links + description: Delete a bucket replica link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_bucket_ids' + - $ref: '#/components/parameters/Local_bucket_names' + - $ref: '#/components/parameters/Remote_bucket_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_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: + - Bucket Replica Links + summary: PATCH bucket-replica-links + description: Modify the configuration of a bucket replica link including whether the link is paused + and the object store remote credentials used. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_bucket_ids' + - $ref: '#/components/parameters/Local_bucket_names' + - $ref: '#/components/parameters/Remote_bucket_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketReplicaLink' + required: true + x-codegen-request-body-name: bucket-replica-link + 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/BucketReplicaLinkResponse' + x-codegen-request-body-name: bucket-replica-link + /api/2.23/certificates: + get: + tags: + - Certificates + summary: GET certificates + description: List array certificates and their attributes. + parameters: + - $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' + 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/CertificateGetResponse' + post: + tags: + - Certificates + summary: POST certificates + description: | + Either upload a CA certificate to the array, upload a new appliance certificate with + a private key, or generate a new self-signed certificate with a new private key and + the specified attributes. + parameters: + - $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: 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/CertificateResponse' + x-codegen-request-body-name: certificate + delete: + tags: + - Certificates + summary: DELETE certificates + description: Delete a CA certificate from the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Certificates + summary: PATCH certificates + description: | + Modify SSL certificate attributes such as importing a new certificate + and private key, or change intermediate certificate chains. + Alternatively, generate a new self-signed certificate with specified properties + to overwrite an existing certificate, and optionally generate a new private key. + parameters: + - $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/CertificatePatch' + required: true + x-codegen-request-body-name: certificate + 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/CertificateResponse' + x-codegen-request-body-name: certificate + /api/2.23/certificates/certificate-groups: + get: + tags: + - Certificates + summary: GET certificates/certificate-groups + description: List membership associations between groups and certificates. + parameters: + - $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' + 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/CertificateCertificateGroupGetResp' + post: + tags: + - Certificates + summary: POST certificates/certificate-groups + description: Add one or more certificates to one or more certificate groups. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateCertificateGroupResponse' + delete: + tags: + - Certificates + summary: DELETE certificates/certificate-groups + description: Remove one or more certificates from one or more certificate groups. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/certificates/certificate-signing-requests: + post: + tags: + - Certificates + summary: Create certificate-signing-requests + description: | + Creates a certificate signing request using a specified certificate and parameters. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateSigningRequestPost' + required: true + x-codegen-request-body-name: certificate + 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/CertificateSigningRequestResponse' + x-codegen-request-body-name: certificate + /api/2.23/certificates/uses: + get: + tags: + - Certificates + summary: GET certificates/uses + description: List how certificates are being used and by what. + parameters: + - $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' + 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/CertificateUseGetResponse' + /api/2.23/certificate-groups: + get: + tags: + - Certificate Groups + summary: GET certificate-groups + description: Display all array certificate groups. + parameters: + - $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' + 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/CertificateGroupGetResponse' + post: + tags: + - Certificate Groups + summary: POST certificate-groups + description: Create one or more certificate groups on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/json: + schema: + $ref: '#/components/schemas/CertificateGroupResponse' + delete: + tags: + - Certificate Groups + summary: DELETE certificate-groups + description: Delete one or more certificate groups from the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/certificate-groups/certificates: + get: + tags: + - Certificate Groups + summary: GET certificate-groups/certificates + description: List membership associations between groups and certificates on the array. + parameters: + - $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' + 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/CertificateGroupCertificateGetResp' + post: + tags: + - Certificate Groups + summary: POST certificate-groups/certificates + description: Add one or more certificates to one or more certificate groups on the array. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateGroupCertificateResponse' + delete: + tags: + - Certificate Groups + summary: DELETE certificate-groups/certificates + description: Delete one or more certificate groups. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/certificate-groups/uses: + get: + tags: + - Certificate Groups + summary: GET certificate-groups/uses + description: List how certificate groups are being used and by what. + parameters: + - $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' + 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/CertificateGroupUseGetResponse' + /api/2.23/data-eviction-policies: + get: + tags: + - Policies - Data Eviction + summary: GET data-eviction-policies + description: List data eviction 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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/DataEvictionPoliciesGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataEvictionPoliciesGetResponse' + post: + tags: + - Policies - Data Eviction + summary: POST data-eviction-policies + description: Create a data eviction policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DataEvictionPolicyPost' + required: true + x-codegen-request-body-name: policy + 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/DataEvictionPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Data Eviction + summary: DELETE data-eviction-policies + description: Delete a data eviction policy. + 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: + - Policies - Data Eviction + summary: PATCH data-eviction-policies + description: Modify a data eviction policy. + 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/DataEvictionPolicy' + required: false + x-codegen-request-body-name: policy + 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/DataEvictionPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/data-eviction-policies/file-systems: + get: + summary: GET data-eviction-policies/file-systems + description: Lists file systems mapped to a data eviction policy. + 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' + 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/DataEvictionPoliciesMembersGetResponse' + + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataEvictionPoliciesMembersGetResponse' + tags: + - Policies - Data Eviction + + post: + summary: POST data-eviction-policies/file-systems + description: Maps a data eviction policy to a file system. + 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/DataEvictionPoliciesMembersResponse' + tags: + - Policies - Data Eviction + + delete: + summary: DELETE data-eviction-policies/file-systems + description: Removes the data eviction policy mapped to a file system. + 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 + tags: + - Policies - Data Eviction + /api/2.23/data-eviction-policies/members: + get: + tags: + - Policies - Data Eviction + summary: GET data-eviction-policies/members + description: Lists file systems mapped to a data eviction policy. + 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' + 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/DataEvictionPoliciesMembersGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataEvictionPoliciesMembersGetResponse' + /api/2.23/directory-services: + get: + tags: + - Directory Services + summary: GET directory-services + description: List directory service configuration information. + parameters: + - $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' + 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/DirectoryServiceGetResponse' + patch: + tags: + - Directory Services + summary: PATCH directory-services + description: | + Modifies and tests the directory service configuration. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DirectoryService' + required: true + x-codegen-request-body-name: directory-service + 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/DirectoryServiceResponse' + x-codegen-request-body-name: directory-service + /api/2.23/directory-services/roles: + get: + tags: + - Directory Services + summary: GET directory-service/roles + description: | + Return array's RBAC group configuration settings for manageability. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids_for_directory_service_roles' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names_for_directory_service_roles' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Role_ids' + - $ref: '#/components/parameters/Role_names' + - $ref: '#/components/parameters/Sort' + 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/DirectoryServiceRolesGetResponse' + post: + tags: + - Directory Services + summary: POST directory-service/roles + description: | + Create an RBAC group configuration setting for manageability. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DirectoryServiceRolePost' + required: true + x-codegen-request-body-name: directory-service-roles + responses: + "200": + description: Returns the newly created directory-service-role object. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DirectoryServiceRolesResponse' + x-codegen-request-body-name: directory-service-roles + delete: + tags: + - Directory Services + summary: DELETE directory-service/roles + description: | + Delete an RBAC group configuration setting for manageability. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Directory Services + summary: PATCH directory-service/roles + description: | + Update an RBAC group configuration setting for manageability. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids_for_directory_service_roles' + - $ref: '#/components/parameters/Names_for_directory_service_roles' + - $ref: '#/components/parameters/Role_ids' + - $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: Returns the newly updated directory-service-role object. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DirectoryServiceRolesResponse' + x-codegen-request-body-name: directory-service-roles + /api/2.23/directory-services/roles/management-access-policies: + get: + tags: + - Policies - Management Access + summary: GET directory-services/roles/management-access-policies + description: | + List management access policies mapped to directory service group mappings. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - Management Access + summary: POST directory-services/roles/management-access-policies + description: Map a directory service group to a management access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - Management Access + summary: DELETE directory-services/roles/management-access-policies + description: Remove the mapping of a directory service group to a management access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/directory-services/test: + get: + tags: + - Directory Services + summary: GET directory-services/test + description: Test the configured directory services on the array. + 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/Sort' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/TestResultRemoteExecutionGet' + "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/TestResultRemoteExecutionGet' + patch: + tags: + - Directory Services + summary: PATCH directory-service/test + description: "Test the configured directory services on the array. Optionally, provide modifications + which will be used to perform the tests, but will not be applied to the current configuration." + parameters: + - $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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + requestBody: + description: | + An optional directory service configuration that, if provided, + will be used to overwrite aspects of the existing directory service + objects when performing tests. + content: + application/json: + schema: + $ref: '#/components/schemas/DirectoryService' + required: false + x-codegen-request-body-name: directory-service + 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/TestResultRemoteExecution' + x-codegen-request-body-name: directory-service + /api/2.23/dns: + get: + tags: + - DNS + summary: GET dns + 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/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' + 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/DnsGetResponse' + post: + tags: + - DNS + summary: POST dns + 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/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DnsPost' + required: true + x-codegen-request-body-name: dns + 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/DnsResponse' + x-codegen-request-body-name: dns + delete: + tags: + - DNS + summary: DELETE dns + description: | + Deletes a DNS configuration. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + responses: + "200": + description: OK + content: {} + patch: + tags: + - DNS + summary: PATCH dns + description: Modify a DNS configuration. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Dns' + required: true + x-codegen-request-body-name: dns + 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/DnsResponse' + x-codegen-request-body-name: dns + /api/2.23/drives: + get: + tags: + - Drives + summary: GET drives + description: List array drive information. + parameters: + - $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_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/DriveGetResponse' + /api/2.23/file-systems: + get: + tags: + - File Systems + summary: GET file-systems + description: List one or more file systems on the array. + 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_only' + - $ref: '#/components/parameters/Workload_ids' + - $ref: '#/components/parameters/Workload_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/FileSystemGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemGetResponse' + post: + tags: + - File Systems + summary: POST file-systems + description: Create a file system on the current array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Default_exports' + - $ref: '#/components/parameters/Discard_non_snapshotted_data' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Overwrite' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemPost' + required: true + x-codegen-request-body-name: file-system + 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/FileSystemResponse' + x-codegen-request-body-name: file-system + delete: + tags: + - File Systems + summary: DELETE file-systems + description: Deletes a file system. Deleting a file system is equivalent to eradication. A file + system's `destroyed` parameter must be set to `true` before a file system can be deleted. + 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: + - File Systems + summary: PATCH file-systems + description: Modify a file system's attributes including its export protocols and limits. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Cancel_storage_class_transition' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Delete_link_on_eradication' + - $ref: '#/components/parameters/Discard_detailed_permissions' + - $ref: '#/components/parameters/Discard_non_snapshotted_data' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Ignore_usage' + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemResponse' + x-codegen-request-body-name: file-system + /api/2.23/file-systems/data-eviction-policies: + get: + summary: GET file-systems/data-eviction-policies + description: Lists file systems mapped to a data eviction policy. + 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' + 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/DataEvictionPoliciesMembersGetResponse' + + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataEvictionPoliciesMembersGetResponse' + tags: + - File Systems + + post: + summary: POST file-systems/data-eviction-policies + description: Maps a data eviction policy to a file system. + 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/DataEvictionPoliciesMembersResponse' + tags: + - File Systems + + delete: + summary: DELETE file-systems/data-eviction-policies + description: Removes the data eviction policy mapped to a file system. + 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: {} + tags: + - File Systems + /api/2.23/file-systems/groups/performance: + get: + tags: + - File Systems + summary: GET file-systems/groups/performance + description: List a group’s I/O performance metrics on a file system. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Gids_not_strict' + - $ref: '#/components/parameters/Group_names_not_strict' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + - $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/FileSystemGroupsPerformanceGetResponse' + /api/2.23/file-systems/performance: + get: + tags: + - File Systems + summary: GET file-systems/performance + description: Displays the performance metrics for a file system. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Protocol' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/FileSystemPerformanceGetResponse' + /api/2.23/file-systems/audit-policies: + get: + tags: + - File Systems + summary: GET file-systems/audit-policies + description: List file systems mapped to a audit policy. + 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' + 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/AuditFileSystemsPoliciesMembersGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AuditFileSystemsPoliciesMembersGetResponse' + post: + tags: + - File Systems + summary: POST file-systems/audit-policies + description: Map a audit policy to a file system. + 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/AuditFileSystemsPoliciesMembersResponse' + delete: + tags: + - File Systems + summary: DELETE file-systems/audit-policies + description: Remove the audit policy mapped to a file system. + 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.23/file-systems/policies: + get: + tags: + - File Systems + summary: GET file-systems/policies + description: | + List file system snapshot scheduling policies. + Note: if more than 150,000 items would be returned in the response, an error will be thrown + and query parameters must be used to limit the items queried. + 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' + 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/PolicyMemberContextGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - File Systems + summary: POST file-systems/policies + description: Apply a snapshot scheduling policy to a file system. Only one file system can be mapped + to a policy at a time. + 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/PolicyMemberContextResponse' + delete: + tags: + - File Systems + summary: DELETE file-systems/policies + description: Remove a snapshot scheduling policy from a file system. + 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.23/file-systems/policies-all: + get: + tags: + - File Systems + summary: GET file-systems/policies-all + description: | + List file system policies. + Note: if more than 150,000 items would be returned in the response, an error will be thrown + and query parameters must be used to limit the items queried. + 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' + 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/PolicyMemberContextGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + /api/2.23/file-systems/users/performance: + get: + tags: + - File Systems + summary: GET file-systems/users/performance + description: List a user’s I/O performance metrics on a file system. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Total_only' + - $ref: '#/components/parameters/Uids_not_strict' + - $ref: '#/components/parameters/User_names_not_strict' + 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/FileSystemUsersPerformanceGetResponse' + /api/2.23/file-systems/worm-data-policies: + get: + tags: + - File Systems + summary: GET file-systems/worm-data-policies + description: List file systems mapped to a WORM data policy. + 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' + 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/WormDataPoliciesMembersGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/WormDataPoliciesMembersGetResponse' + /api/2.23/file-system-exports: + get: + tags: + - File System Exports + summary: GET file-system-exports + description: List one or more file system exports. + 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/Workload_ids' + - $ref: '#/components/parameters/Workload_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/FileSystemExportGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemExportGetResponse' + post: + tags: + - File System Exports + summary: POST file-system-exports + description: Create a file system export. + 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemExportPost' + required: true + x-codegen-request-body-name: file-system-export + 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/FileSystemExportResponse' + x-codegen-request-body-name: file-system-export + delete: + tags: + - File System Exports + summary: DELETE file-system-exports + description: Deletes a file system export. + 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: + - File System Exports + summary: PATCH file-system-exports + description: Modify a file system export’s attributes. + 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/FileSystemExportPatch' + required: true + x-codegen-request-body-name: file-system-export + 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/FileSystemExportResponse' + x-codegen-request-body-name: file-system-export + /api/2.23/file-system-replica-links: + get: + tags: + - File System Replica Links + summary: GET file-system-replica-links + description: List file system replication link. + 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/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + 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/FileSystemReplicaLinkGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemReplicaLinkGetResponse' + post: + tags: + - File System Replica Links + summary: POST file-system-replica-links + description: Create a file system replication link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemReplicaLink' + required: true + x-codegen-request-body-name: file-system-replica-link + 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/FileSystemReplicaLinkResponse' + x-codegen-request-body-name: file-system-replica-link + delete: + tags: + - File System Replica Links + summary: DELETE file-system-replica-links + description: Delete a file system replication link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Cancel_in_progress_transfers' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_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: + - File System Replica Links + summary: PATCH file-system-replica-links + description: Update a file system replication link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Replicate_now' + 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/FileSystemReplicaLinkResponse' + /api/2.23/file-system-replica-links/policies: + get: + tags: + - File System Replica Links + summary: GET file-system-replica-links/policies + description: List file system replication link 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/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + 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/PolicyMemberWithRemoteGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberWithRemoteGetResponse' + post: + tags: + - File System Replica Links + summary: POST file-system-replica-links/policies + description: Add a policy to a file system replication link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_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/PolicyMemberWithRemoteResponse' + delete: + tags: + - File System Replica Links + summary: DELETE file-system-replica-links/policies + description: Remove a policy from a file system replication link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_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.23/file-system-replica-links/transfer: + get: + tags: + - File System Replica Links + summary: GET file-system-replica-links/transfer + description: List the transfer status details for file system replication. + 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_or_owner_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + - $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/FileSystemSnapshotGetTransferResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSnapshotGetTransferResponse' + /api/2.23/file-system-snapshots: + get: + tags: + - File System Snapshots + summary: GET file-system-snapshots + description: | + List file system snapshots. + Note: if more than 150,000 items would be returned in the response, an error will be thrown + and query parameters must be used to limit the items queried. + 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_or_owner_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Owner_ids' + - $ref: '#/components/parameters/Sort' + - $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/FileSystemSnapshotGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSnapshotGetResponse' + post: + tags: + - File System Snapshots + summary: POST file-system-snapshots + description: "Create a snapshot for a specified source file system. If a source file system is not + specified, creates snapshots for all file systems on the array." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Send' + - $ref: '#/components/parameters/Source_ids' + - $ref: '#/components/parameters/Source_names' + - $ref: '#/components/parameters/Targets' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSnapshotPost' + required: false + x-codegen-request-body-name: file-system-snapshot + 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/FileSystemSnapshotResponse' + x-codegen-request-body-name: file-system-snapshot + delete: + tags: + - File System Snapshots + summary: DELETE file-system-snapshots + description: Delete a file system snapshot. + 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: + - File System Snapshots + summary: PATCH file-system-snapshots + description: Modify file system snapshot attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Latest_replica' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSnapshot' + required: true + x-codegen-request-body-name: file-system-snapshot + 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/FileSystemSnapshotResponse' + x-codegen-request-body-name: file-system-snapshot + /api/2.23/file-system-snapshots/policies: + get: + tags: + - File System Snapshots + summary: GET file-system-snapshots/policies + description: | + List file system snapshots mapped to snapshot scheduling policies. + Note: if more than 150,000 items would be returned in the response, an error will be thrown + and query parameters must be used to limit the items queried. + 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' + 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/PolicyFileSystemSnapshotGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyFileSystemSnapshotGetResponse' + delete: + tags: + - File System Snapshots + summary: DELETE file-system-snapshots/policies + description: Remove snapshot scheduling policies from a file system. + 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.23/file-system-snapshots/transfer: + get: + tags: + - File System Snapshots + summary: GET file-system-snapshots/transfer + description: | + List file system snapshot transfers from the source array to the target array. + Note: if more than 150,000 items would be returned in the response, an error will be thrown + and query parameters must be used to limit the items queried. + 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_or_owner_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + - $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/FileSystemSnapshotGetTransferResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSnapshotGetTransferResponse' + delete: + tags: + - File System Snapshots + summary: DELETE file-system-snapshots/transfer + description: Delete file system snapshot transfers from the source array to the target array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_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.23/file-systems/locks: + get: + tags: + - File Systems + summary: Get a list of active file locks + description: | + Lists all active file locks that satisfy the conditions specified by the + parameters. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Client_names' + - $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/Inodes' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Paths' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/FileLockGetResponse' + delete: + tags: + - File Systems + summary: Invalidate file locks + description: | + Invalidates file locks. It can be used to either delete an individual lock + by name or multiple locks filtered by parameters. E.g. to delete locks held + by a client on specific file, parameters `client_names`, `file_system_ids` or + `file_system_names` and `path` must be specified. + When `names` is specified, no other query parameter can be specified. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Client_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Inodes' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Paths' + - $ref: '#/components/parameters/Recursive' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/file-systems/locks/clients: + get: + tags: + - File Systems + summary: Get a list of clients that hold active file locks + description: Lists all clients that hold active file locks. + 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' + 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/FileSystemClientsGetResponse' + /api/2.23/file-systems/locks/nlm-reclamations: + post: + tags: + - File Systems + summary: Initiate NLM reclamation. + description: | + NLM reclamation is a system-wide operation, affecting all clients, and 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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileLockNlmReclamationResponse' + /api/2.23/file-systems/sessions: + get: + tags: + - File Systems + summary: Get a list of active sessions + description: | + Lists all active sessions that satisfy the conditions specified by the + parameters. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Client_names' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Protocols' + - $ref: '#/components/parameters/Sessions_user_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/FileSessionGetResponse' + delete: + tags: + - File Systems + summary: Delete sessions + description: | + Delete sessions. It can be used to either delete an individual session + by name or multiple sessions filtered by parameters. E.g. to delete SMBv3 + sessions held by specific client, `protocols` and `client_names` must be + specified. + To prevent accidental deletes, setting flag `disruptive` to `true` + is required when only a single query parameter is part of the query. + E.g. to delete all SMBv3 sessions, query parameters `protocols` and + `disruptive` must be set. + When `names` is specified, no other query parameter can be specified. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Client_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Disruptive' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Protocols' + - $ref: '#/components/parameters/Sessions_user_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.23/file-systems/space/storage-classes: + get: + tags: + - File Systems + summary: GET file-systems/space/storage-classes + description: List available and used storage space per filesystem. + parameters: + - $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/StorageClassNames' + - $ref: '#/components/parameters/Total_only' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSpaceStorageClassGetResponse' + /api/2.23/file-systems/open-files: + get: + tags: + - File Systems + summary: GET file-systems/open-files + description: List open files. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Client_names' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Open_files_paths' + - $ref: '#/components/parameters/Protocols_required' + - $ref: '#/components/parameters/Session_names' + - $ref: '#/components/parameters/Open_files_user_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/FileSystemOpenFilesGetResponse' + delete: + tags: + - File Systems + summary: DELETE file-systems/open-files + description: Close open file from given identifiers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/fleets: + get: + tags: + - Fleets + summary: GET fleets + description: Displays information about the fleets known to the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids_single' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names_single' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + - $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/FleetGetResponse' + post: + tags: + - Fleets + summary: POST fleets + 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/XRequestId' + - $ref: '#/components/parameters/Names_single' + 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/FleetResponse' + delete: + tags: + - Fleets + summary: DELETE Fleets + description: | + Permanently delete a fleet. A fleet can only be deleted if the current array is the only array + in the fleet. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids_single' + - $ref: '#/components/parameters/Names_single' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Fleets + summary: PATCH fleets + description: | + Rename a fleet 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/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.23/fleets/fleet-key: + get: + tags: + - Fleets + summary: GET fleet-key + description: | + Displays the time remaining on the fleet key. + Note: fleet key itself is not displayed, since that is only available at the time of fleet key + creation. + parameters: + - $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_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/FleetKeyGetResponse' + post: + tags: + - Fleets + summary: POST 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/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FleetKeyResponse' + /api/2.23/fleets/members: + get: + tags: + - Fleets + summary: GET fleet members + description: Displays the members in the current fleet. + parameters: + - $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_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/FleetMemberGetResponse' + post: + tags: + - Fleets + summary: POST fleets + 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/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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FleetMemberResponse' + x-codegen-request-body-name: members + delete: + tags: + - Fleets + summary: Remove fleet members + description: | + Remove 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/XRequestId' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Member_names' + - $ref: '#/components/parameters/Unreachable' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/hardware: + get: + tags: + - Hardware + summary: GET hardware + description: List hardware slots and bays and the status of installed components. + parameters: + - $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' + 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/HardwareGetResponse' + patch: + tags: + - Hardware + summary: PATCH hardware + description: | + Controls the visual identification light of the specified hardware component. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Hardware' + required: true + x-codegen-request-body-name: hardware + 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/HardwareResponse' + x-codegen-request-body-name: hardware + /api/2.23/hardware-connectors: + get: + tags: + - Hardware Connectors + summary: GET hardware-connectors + description: | + The endpoint is deprecated. Use the `/network-interfaces/connectors` endpoint instead. + List array connection information. + parameters: + - $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' + 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/HardwareConnectorGetResponse' + patch: + tags: + - Hardware Connectors + summary: PATCH hardware-connectors + description: | + The endpoint is deprecated. Use the `/network-interfaces/connectors` endpoint instead. + Modify array connection information. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HardwareConnector' + required: true + x-codegen-request-body-name: hardware-connector + 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/HardwareConnectorResponse' + x-codegen-request-body-name: hardware-connector + /api/2.23/hardware-connectors/performance: + get: + tags: + - Hardware Connectors + summary: GET hardware-connectors/performance + description: | + The endpoint is deprecated. Use the `/network-interfaces/connectors/performance` + endpoint instead. + Displays network statistics, historical bandwidth, and error reporting for + all specified hardware connectors. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/HardwareConnectorPerformanceGetResponse' + /api/2.23/keytabs: + get: + tags: + - Keytabs + summary: GET keytabs + description: List a Kerberos keytab file and its configuration information. + parameters: + - $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' + 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/KeytabGetResponse' + post: + tags: + - Keytabs + summary: POST keytabs + description: Import a Kerberos keytab file from a Key Distribution Center. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Name_prefixes' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KeytabPost' + required: true + x-codegen-request-body-name: keytab + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/KeytabResponse' + x-codegen-request-body-name: keytab + delete: + tags: + - Keytabs + summary: DELETE keytabs + description: Delete a Kerberos keytab file. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/keytabs/download: + get: + tags: + - Keytabs + summary: GET keytabs/download + description: "Download a Kerberos keytab file. The file can be downloaded in the native binary format + or a base64 encoded format. If not specified, defaults to binary." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Keytab_ids' + - $ref: '#/components/parameters/Keytab_names' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/octet-stream: + schema: + $ref: '#/components/schemas/KeytabFileResponse' + text/plain: + schema: + $ref: '#/components/schemas/KeytabFileResponse' + /api/2.23/keytabs/upload: + post: + tags: + - Keytabs + summary: POST keytabs/upload + description: "Upload a Kerberos keytab file to the array. The file can be uploaded in the native + binary format or a base64 encoded format. If not specified, defaults to binary. The procedure + to upload a file may vary depending on the type of REST client." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Name_prefixes' + requestBody: + content: + multipart/form-data: + schema: + required: + - keytab_file + type: object + properties: + keytab_file: + $ref: '#/components/schemas/Keytab_file' + required: true + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/octet-stream: + schema: + $ref: '#/components/schemas/KeytabFileResponse' + text/plain: + schema: + $ref: '#/components/schemas/KeytabFileResponse' + /api/2.23/kmip: + get: + tags: + - KMIP + summary: List KMIP server configurations + description: | + Displays a list of KMIP server configurations. + parameters: + - $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' + 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/KmipServerResponse' + post: + tags: + - KMIP + summary: Create a KMIP server configuration + description: Creates a KMIP server configuration. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KmipServer' + required: true + x-codegen-request-body-name: kmip-server + 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/KmipServerResponse' + x-codegen-request-body-name: kmip-server + delete: + tags: + - KMIP + summary: Delete a KMIP server configuration + description: | + Deletes a KMIP server configuration. A server can only be deleted when not in use by the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - KMIP + summary: Modify a KMIP server configuration + description: | + Modifies KMIP server properties - URI, certificate, certificate group. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KmipServer' + required: true + x-codegen-request-body-name: kmip-server + 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/KmipServerResponse' + x-codegen-request-body-name: kmip-server + /api/2.23/kmip/test: + get: + tags: + - KMIP + summary: Displays KMIP server test results + description: | + Displays a detailed result of of KMIP server test. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/json: + schema: + $ref: '#/components/schemas/TestResultResponse' + /api/2.23/legal-holds: + get: + tags: + - Legal Holds + summary: List legal holds + description: List legal holds. + parameters: + - $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' + 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/LegalHoldsGetResponse' + post: + tags: + - Legal Holds + summary: Create a legal hold + description: Create a legal hold instance. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LegalHold' + required: false + x-codegen-request-body-name: hold + 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/LegalHoldsResponse' + x-codegen-request-body-name: hold + delete: + tags: + - Legal Holds + summary: Delete a legal hold + description: Delete a legal hold instance. Deletion is not allowed if the legal hold is applied + to one or more paths. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Legal Holds + summary: Update a legal hold + description: Update a legal hold instance. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LegalHold' + required: false + x-codegen-request-body-name: hold + 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/LegalHoldsResponse' + x-codegen-request-body-name: hold + /api/2.23/legal-holds/held-entities: + get: + tags: + - Legal Holds + summary: List held entities + description: List entities to which a legal hold has been applied. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Paths' + 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/LegalHoldsHeldEntitiesGetResponse' + post: + tags: + - Legal Holds + summary: Apply this legal hold to a new entity + description: | + Apply this legal hold to a new entity. + The `names`, `file_system_names` and `paths` query parameters are required. + The `recursive` flag is required when applying a hold to a directory. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Paths' + - $ref: '#/components/parameters/Legal_holds_recursive' + 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/LegalHoldsHeldEntitiesResponse' + patch: + tags: + - Legal Holds + summary: Release this legal hold from the given entity + description: | + Release this legal hold from the given entity. + The `names`, `file_system_names`, `paths` and `released` query parameters are required. + The `recursive` flag is required when releasing a hold from a directory. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Paths' + - $ref: '#/components/parameters/Legal_holds_recursive' + - $ref: '#/components/parameters/Legal_holds_release' + 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/LegalHoldsHeldEntitiesResponse' + /api/2.23/lifecycle-rules: + get: + tags: + - Lifecycle Rules + summary: GET lifecycle-rules + description: |+ + Returns a list of lifecycle rules. + If `names` is specified, list the individual rules. + If `ids` is specified, `bucket_names` or `bucket_ids` is also required. + If `bucket_names` or `bucket_ids` are specified without `ids`, + list all the rules for the bucket. + + 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' + 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. + 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' + post: + tags: + - Lifecycle Rules + summary: 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 "fbRuleIdX". + + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Confirm_date' + - $ref: '#/components/parameters/Context_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LifecycleRulePost' + 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: 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: 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/LifecycleRulePatch' + 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.23/link-aggregation-groups: + get: + tags: + - Link Aggregation Groups + summary: GET link-aggregation-groups + description: List the status and attributes of the Ethernet ports in the configured link aggregation + groups. + parameters: + - $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' + 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/LinkAggregationGroupGetResponse' + post: + tags: + - Link Aggregation Groups + summary: POST link-aggregation-groups + description: Create a link aggregation group of Ethernet ports on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LinkAggregationGroup' + required: true + x-codegen-request-body-name: link-aggregation-group + 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/LinkAggregationGroupResponse' + x-codegen-request-body-name: link-aggregation-group + delete: + tags: + - Link Aggregation Groups + summary: DELETE link-aggregation-groups + description: Remove a link aggregation group to unbind the ports. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Link Aggregation Groups + summary: PATCH link-aggregation-groups + description: Modify link aggregation groups by adding and removing Ethernet ports. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LinkAggregationGroupPatch' + required: true + x-codegen-request-body-name: link-aggregation-group + 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/LinkAggregationGroupResponse' + x-codegen-request-body-name: link-aggregation-group + /api/2.23/logs: + get: + tags: + - Logs + summary: GET logs + description: Download a history of log events from the array to provide to Pure Technical Services + for analysis. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Start_time' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/octet-stream: + schema: + type: string + format: binary + text/plain: + schema: + type: string + format: binary + application/json: + schema: + type: string + format: binary + /api/2.23/logs-async: + get: + tags: + - Logs + summary: GET logs-async + description: List the attributes and status of preparation for a history of log events from the + array to provide to Pure Technical Services for analysis. + parameters: + - $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' + 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/LogsAsyncGetResponse' + patch: + tags: + - Logs + summary: PATCH logs-async + description: Start the preparation for a history of log events from the array to provide to Pure + Technical Services for analysis. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogsAsync' + required: true + x-codegen-request-body-name: logs-async + 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/LogsAsyncResponse' + x-codegen-request-body-name: logs-async + /api/2.23/logs-async/download: + get: + tags: + - Logs + summary: GET logs-async/download + description: Download the files which contain a history of log events from the array to provide + to Pure Technical Services for analysis. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/octet-stream: + schema: + type: string + format: binary + text/plain: + schema: + type: string + format: binary + application/json: + schema: + type: string + format: binary + /api/2.23/log-targets/file-systems: + get: + tags: + - Audit Log Target for File Systems + summary: GET log-target-file-systems + description: Displays a list of log targets for file systems. + 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' + 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/LogTargetsFileSystemsGetResponse' + post: + tags: + - Audit Log Target for File Systems + summary: POST log-target-file-systems + description: Create a new log target for file systems. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogTargetsFileSystemsPost' + required: false + x-codegen-request-body-name: log-target-file-system + 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/LogTargetsFileSystemsResponse' + x-codegen-request-body-name: log-target-file-system + delete: + tags: + - Audit Log Target for File Systems + summary: DELETE log-target-file-systems + description: Delete one or more log targets. + 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: + - Audit Log Target for File Systems + summary: PATCH log-target-file-systems + description: Modify an existing log target's attributes. + 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/LogTargetsFileSystems' + required: true + x-codegen-request-body-name: log-target-file-system + 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/LogTargetsFileSystemsResponse' + x-codegen-request-body-name: log-target-file-system + /api/2.23/log-targets/object-store: + get: + tags: + - Audit Log Target for Object Store + summary: GET log-targets/object-store + description: Displays a list of log targets for object audit. + 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' + 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/LogTargetsObjectStoreGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/LogTargetsObjectStoreGetResponse' + post: + tags: + - Audit Log Target for Object Store + summary: POST log-targets/object-store + description: Create a new log target for object audit. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogTargetsObjectStorePost' + required: false + x-codegen-request-body-name: log-target-object-store + 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/LogTargetsObjectStoreResponse' + x-codegen-request-body-name: log-target-object-store + delete: + tags: + - Audit Log Target for Object Store + summary: DELETE log-targets/object-store + description: Delete one or more log targets. + 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: + - Audit Log Target for Object Store + summary: PATCH log-targets/object-store + description: Modify an existing log target's attributes. + 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/LogTargetsObjectStore' + required: true + x-codegen-request-body-name: log-target-object-store + 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/LogTargetsObjectStoreResponse' + x-codegen-request-body-name: log-target-object-store + /api/2.23/maintenance-windows: + get: + tags: + - Maintenance Windows + summary: List maintenance window details + description: "Displays maintenance window details, including start time, end time, and maintenance + type." + parameters: + - $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' + 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/MaintenanceWindowsGetResponse' + post: + tags: + - Maintenance Windows + summary: 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 `array`. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MaintenanceWindowPost' + required: true + x-codegen-request-body-name: maintenance-window + 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/MaintenanceWindowsResponse' + x-codegen-request-body-name: maintenance-window + delete: + tags: + - Maintenance Windows + summary: Delete maintenance window + description: | + Deletes an active maintenance window before its scheduled end (`expire`) time. + The `names` parameter is required and must be set to `array`. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/management-access-policies: + get: + tags: + - Policies - Management Access + summary: GET management-access-policies + description: | + Displays a list of management access policies, which can be assigned to admins, API + clients, or directory-service roles. + parameters: + - $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' + 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/ManagementAccessPoliciesGetResponse' + post: + tags: + - Policies - Management Access + summary: POST management-access-policies + description: | + Create a new management access policy, which can be assigned to admins, API + clients, or directory-service roles. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManagementAccessPolicyPost' + required: false + x-codegen-request-body-name: policy + 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/ManagementAccessPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Management Access + summary: DELETE management-access-policies + description: Delete one or more management access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Policies - Management Access + summary: PATCH management-access-policies + description: | + Modify an existing management access policy, which can be assigned to admins, API + clients, or directory-service roles. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManagementAccessPolicy' + required: true + x-codegen-request-body-name: policy + 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/ManagementAccessPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/management-access-policies/admins: + get: + tags: + - Policies - Management Access + summary: GET management-access-policies/admins + description: | + List management access policies mapped to admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - Management Access + summary: POST management-access-policies/admins + description: Map an admin to a management access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - Management Access + summary: DELETE management-access-policies/admins + description: Remove the mapping of an admin to a management access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/management-access-policies/directory-services/roles: + get: + tags: + - Policies - Management Access + summary: GET management-access-policies/directory-services/roles + description: | + List management access policies mapped to directory service group mappings. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - Management Access + summary: POST management-access-policies/directory-services/roles + description: Map a directory service group to a management access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - Management Access + summary: DELETE management-access-policies/directory-services/roles + description: Remove the mapping of a directory service group to a management access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/management-access-policies/members: + get: + tags: + - Policies - Management Access + summary: GET management-access-policies/members + description: | + List the members mapped to management access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + /api/2.23/management-authentication-policies: + get: + tags: + - Policies - Management Authentication + summary: GET management-authentication-policies + description: | + Displays a list of management authentication policies, which can be assigned to admins and + arrays. + 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' + 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/ManagementAuthenticationPoliciesGetResponse' + post: + tags: + - Policies - Management Authentication + summary: POST management-authentication-policies + description: Create management authentication policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManagementAuthenticationPolicyPost' + required: true + x-codegen-request-body-name: policy + 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/ManagementAuthenticationPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Management Authentication + summary: DELETE management-authentication-policies + description: Delete management authentication policies. + 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: + - Policies - Management Authentication + summary: PATCH management-authentication-policies + description: Modify one or more attributes of management authentication policies. + 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/ManagementAuthenticationPolicy' + required: true + x-codegen-request-body-name: policy + 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/ManagementAuthenticationPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/management-authentication-policies/members: + get: + tags: + - Policies - Management Authentication + summary: GET management-authentication-policies/members + description: List the members mapped to management authentication 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/Management_access_policies_member_types' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Management Authentication + summary: POST management-authentication-policies/members + description: Map a member to a management authentication policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Member_names' + - $ref: '#/components/parameters/Management_access_policies_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/PolicyMemberContextResponse' + delete: + tags: + - Policies - Management Authentication + summary: DELETE management-authentication-policies/members + description: Remove the management authentication policy mapped to a member. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Member_names' + - $ref: '#/components/parameters/Management_access_policies_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.23/network-access-policies: + get: + tags: + - Policies - Network Access + summary: GET network-access-policies + description: Displays a list of network access policies. + parameters: + - $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' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyGetResponse' + patch: + tags: + - Policies - Network Access + summary: PATCH network-access-policies + description: Modify an existing network access policy's attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicy' + required: true + x-codegen-request-body-name: policy + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/network-access-policies/members: + get: + tags: + - Policies - Network Access + summary: GET network-access-policies/members + description: | + List network access policies mapped to different configurations on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberGetResponse' + /api/2.23/network-access-policies/rules: + get: + tags: + - Policies - Network Access + summary: GET network-access-policies/rules + description: Displays a list of network access policy rules. + parameters: + - $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/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyRuleGetResponse' + post: + tags: + - Policies - Network Access + summary: POST network-access-policies/rules + description: | + Create a new network access policy rule. + Either `policy_ids` or `policy_names` parameter is required. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyRulePost' + required: true + x-codegen-request-body-name: rule + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - Network Access + summary: DELETE network-access-policies/rules + description: Delete one or more network access policy rules. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + responses: + "200": + description: OK + content: {} + patch: + tags: + - Policies - Network Access + summary: PATCH network-access-policies/rules + description: Modify an existing network access policy rule. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyRule' + required: true + x-codegen-request-body-name: rule + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/network-interfaces: + get: + tags: + - Network Interfaces + summary: GET network-interfaces + description: List network interfaces and their attributes. + parameters: + - $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' + 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/NetworkInterfaceGetResponse' + post: + tags: + - Network Interfaces + summary: POST network-interfaces + description: Create a VIP to export data or perform replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkInterface' + required: true + x-codegen-request-body-name: network-interface + 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/NetworkInterfaceResponse' + x-codegen-request-body-name: network-interface + delete: + tags: + - Network Interfaces + summary: DELETE network-interfaces + description: "Remove a VIP. Once a data VIP is removed, any clients connected through the data VIP + will lose their connection to the file system or bucket." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Network Interfaces + summary: PATCH network-interfaces + description: Modify the attributes of a VIP. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkInterfacePatch' + required: true + x-codegen-request-body-name: network-interface + 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/NetworkInterfaceResponse' + x-codegen-request-body-name: network-interface + /api/2.23/network-interfaces/ping: + get: + tags: + - Network Interfaces + summary: GET network-interfaces/ping + description: | + Display network interface ping result. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ping_trace_component' + - $ref: '#/components/parameters/Ping_count' + - $ref: '#/components/parameters/Ping_trace_destination' + - $ref: '#/components/parameters/Packet_size' + - $ref: '#/components/parameters/Print_latency' + - $ref: '#/components/parameters/Resolve_hostname' + - $ref: '#/components/parameters/Ping_trace_source' + 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/NetworkInterfacePingGetResponse' + /api/2.23/network-interfaces/trace: + get: + tags: + - Network Interfaces + summary: GET network-interfaces/trace + description: | + Display network interface trace result. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ping_trace_component' + - $ref: '#/components/parameters/Ping_trace_destination' + - $ref: '#/components/parameters/Mtu' + - $ref: '#/components/parameters/Fragment_packet' + - $ref: '#/components/parameters/Method' + - $ref: '#/components/parameters/Port' + - $ref: '#/components/parameters/Resolve_hostname' + - $ref: '#/components/parameters/Ping_trace_source' + 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/NetworkInterfaceTraceGetResponse' + /api/2.23/network-interfaces/tls-policies: + get: + tags: + - Policies - TLS + summary: GET network-interfaces/tls-policies + description: List network interface TLS policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - TLS + summary: POST network-interfaces/tls-policies + description: Apply a TLS policy to a specific network interface. A given network interface may only + have 1 TLS policy applied to it at any given time. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - TLS + summary: DELETE network-interfaces/tls-policies + description: Remove a TLS policy from a network interface. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/network-interfaces/connectors: + get: + tags: + - Network Interfaces + summary: GET network-interfaces/connectors + description: List network connector information + parameters: + - $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' + 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/NetworkInterfacesConnectorsGetResponse' + patch: + tags: + - Network Interfaces + summary: PATCH network-interfaces/connectors + description: Modify network connector information. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HardwareConnector' + required: true + x-codegen-request-body-name: network-connector + 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/NetworkInterfacesConnectorsResponse' + x-codegen-request-body-name: network-connector + /api/2.23/network-interfaces/connectors/performance: + get: + tags: + - Network Interfaces + summary: GET network connectors performance statistics + description: | + Displays network statistics, historical bandwidth, and error reporting for + all specified network connectors. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/NetworkInterfacesConnectorsPerformanceGetResponse' + /api/2.23/network-interfaces/connectors/settings: + get: + tags: + - Network Interfaces + summary: GET global network settings for network connectors + description: Display the global network settings for network connectors. + parameters: + - $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' + 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/NetworkInterfacesConnectorsSettingsGetResponse' + /api/2.23/network-interfaces/network-connection-statistics: + get: + tags: + - Network Interfaces + summary: GET network-interfaces/network-connection-statistics + description: | + Display network interface status + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/NetworkConnectionStatisticsCurrent_state' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/NetworkConnectionStatisticsLocal_host' + - $ref: '#/components/parameters/NetworkConnectionStatisticsLocal_port' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/NetworkConnectionStatisticsRemote_host' + - $ref: '#/components/parameters/NetworkConnectionStatisticsRemote_port' + - $ref: '#/components/parameters/Sort' + 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/NetworkConnectionStatisticsGetResponse' + /api/2.23/network-interfaces/neighbors: + get: + tags: + - Network Interfaces + summary: List network interface neighbors + description: Displays all neighbors for all network interfaces on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Local_port_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/NetworkInterfaceNeighborGetResponse' + /api/2.23/nfs-export-policies: + get: + tags: + - Policies - NFS + summary: GET nfs-export-policies + description: Displays a list of NFS export 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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Workload_ids' + - $ref: '#/components/parameters/Workload_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/NfsExportPolicyGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyGetResponse' + post: + tags: + - Policies - NFS + summary: POST nfs-export-policies + description: Create a new NFS export policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyPost' + required: false + x-codegen-request-body-name: policy + 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/NfsExportPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - NFS + summary: DELETE nfs-export-policies + description: Delete one or more NFS export policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Policies - NFS + summary: PATCH nfs-export-policies + description: Modify an existing NFS export policy's attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyPatch' + required: true + x-codegen-request-body-name: policy + 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/NfsExportPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/nfs-export-policies/rules: + get: + tags: + - Policies - NFS + summary: GET nfs-export-policies/rules + description: | + Displays a list of NFS export policy rules. + The default sort is by policy name, then index. + 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/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/NfsExportPolicyRuleGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyRuleGetResponse' + post: + tags: + - Policies - NFS + summary: POST nfs-export-policies/rules + description: | + Add a NFS export policy rule. Rules are ordered in three groups; ip addresses, other and `*`. + The new rule will be added at the end of the appropriate group if neither + `before_rule_id` and `before_rule_name` are specified. Rules can only be inserted into the + appropriate group. + Either `policy_ids` or `policy_names` parameter is required. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyRule' + 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/NfsExportPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - NFS + summary: DELETE nfs-export-policies/rules + description: | + Delete one or more NFS export policy rules. + One of the following is required: `ids` or `names`. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Policies - NFS + summary: PATCH nfs-export-policies/rules + description: | + Modify an existing NFS export policy rule. + If `before_rule_id` or `before_rule_name` are specified, the rule will be moved before that + rule. Rules are ordered in three groups; ip addresses, other and `*` and can only be moved + within the appropriate group. + One of the following is required: `ids` or `names`. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyRulePatch' + 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/NfsExportPolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/nodes: + get: + tags: + - Nodes + summary: GET nodes + description: List one or more nodes. + parameters: + - $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_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/NodeGetResponse' + patch: + tags: + - Nodes + summary: PATCH nodes + description: Modify a node's attributes including its management address and serial number. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + required: false + x-codegen-request-body-name: node + 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/NodeResponse' + x-codegen-request-body-name: node + /api/2.23/nodes/batch: + post: + tags: + - Nodes + summary: POST nodes/batch + description: Add one or more nodes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Add_to_groups' + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Node' + required: true + x-codegen-request-body-name: items + 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/NodeResponse' + x-codegen-request-body-name: items + /api/2.23/node-groups: + get: + tags: + - Node Groups + summary: GET node-groups + description: Display all array node groups. + parameters: + - $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' + 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/NodeGroupGetResponse' + post: + tags: + - Node Groups + summary: POST node-groups + description: Create one or more node groups on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupResponse' + patch: + tags: + - Node Groups + summary: PATCH node-groups + description: Update one or more node groups on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupPatch' + required: true + x-codegen-request-body-name: node-group + 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/NodeGroupResponse' + delete: + tags: + - Node Groups + summary: DELETE node-groups + description: Delete one or more node groups from the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/node-groups/nodes: + get: + tags: + - Node Groups + summary: GET node-groups/nodes + description: List membership associations between node groups and nodes on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Node_group_ids' + - $ref: '#/components/parameters/Node_group_names' + - $ref: '#/components/parameters/Node_ids' + - $ref: '#/components/parameters/Node_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/NodeGroupNodeGetResponse' + post: + tags: + - Node Groups + summary: POST node-groups/nodes + description: Add one or more nodes to one or more node groups on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Node_group_ids' + - $ref: '#/components/parameters/Node_group_names' + - $ref: '#/components/parameters/Node_ids' + - $ref: '#/components/parameters/Node_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/NodeGroupNodeResponse' + delete: + tags: + - Node Groups + summary: DELETE node-groups/nodes + description: Remove one or more nodes from one or more groups. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Node_group_ids' + - $ref: '#/components/parameters/Node_group_names' + - $ref: '#/components/parameters/Node_ids' + - $ref: '#/components/parameters/Node_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.23/node-groups/uses: + get: + tags: + - Node Groups + summary: GET node-groups/uses + description: List how node groups are being used and by what. + parameters: + - $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' + 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/NodeGroupUseGetResponse' + /api/2.23/object-store-access-keys: + get: + tags: + - Object Store Access Keys + summary: 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' + 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. + 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' + post: + tags: + - Object Store Access Keys + summary: POST object-store-access-keys + description: | + Create or import object store access keys. When importing an access key, + the access key id is provided by the `names` header parameter and the + the secret key must be also provided. When importing an access key for a + user in a realm, the value of `names` must be prefixed with the realm of the + user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Access_key_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccessKeyPost' + 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: 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: 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.23/object-store-access-policies: + get: + tags: + - Policies - Object Store Access + summary: GET object-store-access-policies + description: List access policies 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/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' + 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. + 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' + post: + tags: + - Policies - Object Store Access + summary: POST object-store-access-policies + description: Create a new access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Enforce_action_restrictions' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccessPolicyPost' + required: false + x-codegen-request-body-name: policy + 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/ObjectStoreAccessPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Object Store Access + summary: DELETE object-store-access-policies + description: Delete one or more access policies. + 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: + - Policies - Object Store Access + summary: PATCH object-store-access-policies + description: Modify the rules of an object store access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Enforce_action_restrictions' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccessPolicyPatch' + required: false + x-codegen-request-body-name: policy + 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/ObjectStoreAccessPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/object-store-access-policies/object-store-roles: + get: + tags: + - Policies - Object Store Access + summary: GET object-store-access-policies/object-store-roles + description: List object store roles 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' + 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/PolicyMemberContextGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Object Store Access + summary: POST object-store-access-policies/object-store-roles + description: Grant access policies to an object store role. + 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/PolicyMemberContextResponse' + delete: + tags: + - Policies - Object Store Access + summary: DELETE object-store-access-policies/object-store-roles + description: Revoke an object store role'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.23/object-store-access-policies/object-store-users: + get: + tags: + - Policies - Object Store Access + summary: GET object-store-access-policies/object-store-users + 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' + 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/PolicyMemberContextGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Object Store Access + summary: POST object-store-access-policies/object-store-users + 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/PolicyMemberContextResponse' + delete: + tags: + - Policies - Object Store Access + summary: DELETE object-store-access-policies/object-store-users + 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/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.23/object-store-access-policies/rules: + get: + tags: + - Policies - Object Store Access + summary: GET object-store-access-policies-rules + description: List access policy rules 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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. + 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' + post: + tags: + - Policies - Object Store Access + summary: POST object-store-access-policies-rules + description: Create a new access policy rule. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Enforce_action_restrictions' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyRuleObjectAccessPost' + 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/ObjectStoreAccessPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - Object Store Access + summary: DELETE object-store-access-policies-rules + description: Delete one or more access policy rules. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Policies - Object Store Access + summary: PATCH object-store-access-policies-rules + description: Modify an access policy rule's attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Enforce_action_restrictions' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyRuleObjectAccessPost' + 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/ObjectStoreAccessPolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/object-store-access-policy-actions: + get: + tags: + - Policies - Object Store Access + summary: GET object-store-access-policy-actions + description: |+ + List valid actions for access policy rules. Each action is either a valid + AWS S3 action (prefixed by `s3:`) or our special wildcard action (`s3:*`). + Each action, when included in a rule, may restrict which other properties + may be set for that rule. + + 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' + 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/ObjectStoreAccessPolicyActionGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccessPolicyActionGetResponse' + /api/2.23/object-store-accounts: + get: + tags: + - Object Store Accounts + summary: GET object-store-accounts + description: List object store accounts 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_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. + 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' + post: + tags: + - Object Store Accounts + summary: POST object-store-accounts + description: | + Create an object store account. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccountPost' + required: false + x-codegen-request-body-name: object-store-account + 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: DELETE object-store-accounts + description: Delete 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: {} + patch: + tags: + - Object Store Accounts + summary: PATCH object-store-accounts + description: Modify object store account attributes such as quota limit and bucket defaults. + parameters: + - $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/ObjectStoreAccountPatch' + required: true + x-codegen-request-body-name: object-store-account + 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 + /api/2.23/object-store-account-exports: + get: + tags: + - Object Store Account Exports + summary: GET object-store-account-exports + description: List one or more object store account exports. + 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' + 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/ObjectStoreAccountExportGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccountExportGetResponse' + post: + tags: + - Object Store Account Exports + summary: POST object-store-account-exports + description: Create an account export. + 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccountExportPost' + required: true + x-codegen-request-body-name: object-store-account-export + 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/ObjectStoreAccountExportResponse' + x-codegen-request-body-name: object-store-account-export + delete: + tags: + - Object Store Account Exports + summary: DELETE object-store-account-exports + description: Deletes an account export. + 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: + - Object Store Account Exports + summary: PATCH object-store-account-exports + description: Modify an account export’s attributes. + 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/ObjectStoreAccountExportPatch' + required: true + x-codegen-request-body-name: object-store-account-export + 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/ObjectStoreAccountExportResponse' + x-codegen-request-body-name: object-store-account-export + /api/2.23/object-store-remote-credentials: + get: + tags: + - Object Store Remote Credentials + summary: GET object-store-remote-credentials + description: List object store remote credentials used by bucket replica links to access buckets + on remote arrays or targets. + 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' + 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/ObjectStoreRemoteCredentialGetResp' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRemoteCredentialGetResp' + post: + tags: + - Object Store Remote Credentials + summary: POST object-store-remote-credentials + description: Create object store remote credentials to set up bucket replicat links to a remote + array or target. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRemoteCredentialsPost' + required: true + x-codegen-request-body-name: remote-credentials + 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/ObjectStoreRemoteCredentialsResp' + x-codegen-request-body-name: remote-credentials + delete: + tags: + - Object Store Remote Credentials + summary: DELETE object-store-remote-credentials + description: Delete object store remote credentials. + 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: + - Object Store Remote Credentials + summary: PATCH object-store-remote-credentials + description: Rename and/or change the access key/secret key pair for object store remote credentials. + 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/ObjectStoreRemoteCredentials' + required: true + x-codegen-request-body-name: remote-credentials + 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/ObjectStoreRemoteCredentialsResp' + x-codegen-request-body-name: remote-credentials + /api/2.23/object-store-roles: + get: + tags: + - Object Store Roles + summary: GET object-store-roles + description: List object store roles 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' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRoleGetResponse' + "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/ObjectStoreRoleGetResponse' + post: + tags: + - Object Store Roles + summary: POST object-store-roles + description: Create new object store roles. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRolePost' + required: true + x-codegen-request-body-name: object-store-role + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRoleResponse' + x-codegen-request-body-name: object-store-role + delete: + tags: + - Object Store Roles + summary: DELETE object-store-roles + description: Delete existing object store roles. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + responses: + "200": + description: OK + content: {} + patch: + tags: + - Object Store Roles + summary: PATCH object-store-roles + description: Modify existing object store roles. + 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/ObjectStoreRole' + required: true + x-codegen-request-body-name: object-store-role + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRoleResponse' + x-codegen-request-body-name: object-store-role + /api/2.23/object-store-roles/object-store-access-policies: + get: + tags: + - Object Store Roles + summary: GET object-store-roles/object-store-access-policies + description: List object store roles 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' + 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/PolicyMemberContextGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Object Store Roles + summary: POST object-store-roles/object-store-access-policies + description: Grant access policies to an object store role. + 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/PolicyMemberContextResponse' + delete: + tags: + - Object Store Roles + summary: DELETE object-store-roles/object-store-access-policies + description: Revoke an object store role'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.23/object-store-roles/object-store-trust-policies: + get: + tags: + - Object Store Roles + summary: GET object-store-roles/object-store-trust-policies + description: List object store roles and their trust 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/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + - $ref: '#/components/parameters/Sort' + 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/ObjectStoreTrustPolicyGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreTrustPolicyGetResponse' + /api/2.23/object-store-roles/object-store-trust-policies/download: + get: + tags: + - Object Store Roles + summary: GET object-store-roles/object-store-trust-policies/download + description: Download object store roles and their trust policies in native AWS format. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_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/ObjectStoreTrustPolicyIam' + /api/2.23/object-store-roles/object-store-trust-policies/upload: + patch: + tags: + - Object Store Roles + summary: PATCH object-store-roles/object-store-trust-policies/upload + description: Upload object store roles and their trust policies in native AWS format. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + requestBody: + description: The trust policy document to upload. + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreTrustPolicyIam' + required: true + x-codegen-request-body-name: policy_document + 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/ObjectStoreTrustPolicyResponse' + x-codegen-request-body-name: policy_document + /api/2.23/object-store-roles/object-store-trust-policies/rules: + get: + tags: + - Object Store Roles + summary: GET object-store-roles/object-store-trust-policies/rules + description: List trust policy rules 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/Indices' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + - $ref: '#/components/parameters/Sort' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreTrustPolicyRuleGetResponse' + "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/ObjectStoreTrustPolicyRuleGetResponse' + post: + tags: + - Object Store Roles + summary: POST object-store-roles/object-store-trust-policies/rules + description: Create a new trust policy rule. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrustPolicyRulePost' + required: true + x-codegen-request-body-name: rule + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreTrustPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Object Store Roles + summary: DELETE object-store-roles/object-store-trust-policies/rules + description: Delete one or more trust policy rules. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Indices' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + responses: + "200": + description: OK + content: {} + patch: + tags: + - Object Store Roles + summary: PATCH object-store-roles/object-store-trust-policies/rules + description: Modify a trust policy rule's attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Indices' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrustPolicyRulePost' + required: true + x-codegen-request-body-name: rule + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreTrustPolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/object-store-users: + get: + tags: + - Object Store Users + summary: 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' + 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. + 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' + post: + tags: + - Object Store Users + summary: 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/Full_access' + - $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: 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.23/object-store-users/object-store-access-policies: + get: + tags: + - Object Store Users + summary: GET object-store-users/object-store-access-policies + 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' + 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/PolicyMemberContextGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Object Store Users + summary: POST object-store-users/object-store-access-policies + 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/PolicyMemberContextResponse' + delete: + tags: + - Object Store Users + summary: DELETE object-store-users/object-store-access-policies + 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.23/object-store-virtual-hosts: + get: + tags: + - Object Store Virtual Hosts + summary: GET object-store-virtual-hosts + description: List 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' + 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: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreVirtualHostGetResponse' + post: + tags: + - Object Store Virtual Hosts + summary: POST object-store-virtual-hosts + description: | + Create an object store virtual host. + + Only 10 virtual hosts are supported. + + A `hostname` cannot exceed 255 characters in length, it cannot be an IP address, + supersets or subsets of existing hostnames with the same root are not allowed. + The default `hostname` is s3.amazonaws.com and it cannot be deleted. + + Either `name` or `id` must be provided for each attached server. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreVirtualHost' + x-codegen-request-body-name: object-store-virtual-host + 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: DELETE object-store-virtual-hosts + description: Delete 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: {} + patch: + tags: + - Object Store Virtual Hosts + summary: PATCH object-store-virtual-hosts + description: | + Modify an existing object store virtual host. + + A `hostname` cannot exceed 255 characters in length, it cannot be an IP address, + supersets or subsets of existing hostnames with the same root are not allowed. + + Either `name` or `id` must be provided for each attached server. If `attached_servers` + is specified, the whole list of attached servers will be replaced. The servers + listed in `add_attached_servers` will be added to the existing list of attached + servers and the servers listed in `remove_attached_servers` will be removed from + the existing list of attached servers. If both `add_attached_servers` and + `remove_attached_servers` are specified, the two sets of servers must + be disjoint. If `add_attached_servers` or `remove_attached_servers` are specified, + `attached_servers` must not be specified. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreVirtualHostPatch' + x-codegen-request-body-name: object-store-virtual-host + 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' + /api/2.23/password-policies: + get: + tags: + - Policies - Password + summary: List password policies + description: | + Displays a list of password policies. + parameters: + - $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' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordPoliciesGetResponse' + patch: + tags: + - Policies - Password + summary: 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/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordPolicy' + required: true + x-codegen-request-body-name: policy + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/policies: + get: + tags: + - Policies - Snapshot + summary: GET policies + description: Display snapshot scheduling policies 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/Workload_ids' + - $ref: '#/components/parameters/Workload_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/PolicyGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyGetResponse' + post: + tags: + - Policies - Snapshot + summary: POST policies + description: "Create a new snapshot scheduling policy with rule attributes to capture file system + snapshots for a set period of time and frequency, as well as how long snapshots are retained before + being destroyed and eradicated." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyPost' + required: false + x-codegen-request-body-name: policy + 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/PolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Snapshot + summary: DELETE policies + description: Delete one or more snapshot scheduling policies. + 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: + - Policies - Snapshot + summary: PATCH policies + description: Modify a snapshot scheduling policy's attributes for when and how often snapshots are + created and how long they are retained. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Destroy_snapshots' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotPolicyPatch' + required: true + x-codegen-request-body-name: policy + 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/PolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/policies/file-systems: + get: + tags: + - Policies - Snapshot + summary: GET policies/file-systems + description: | + List file systems mapped to a snapshot scheduling policy. + Note: if more than 150,000 items would be returned in the response, an error will be thrown + and query parameters must be used to limit the items queried. + 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' + 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/PolicyMemberContextGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Snapshot + summary: POST policies/file-systems + description: Map a file system to a snapshot scheduling 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: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextResponse' + delete: + tags: + - Policies - Snapshot + summary: DELETE policies/file-systems + description: Remove the snapshot scheduling policy mapped to a file system. + 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.23/policies/file-system-snapshots: + get: + tags: + - Policies - Snapshot + summary: GET policies/file-system-snapshots + description: | + List file system snapshots mapped to a snapshot scheduling policy. + Note: if more than 150,000 items would be returned in the response, an error will be thrown + and query parameters must be used to limit the items queried. + 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' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyFileSystemSnapshotGetResponse' + "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/PolicyFileSystemSnapshotGetResponse' + delete: + tags: + - Policies - Snapshot + summary: DELETE policies/file-system-snapshots + description: Remove the snapshot scheduling policy mapped to a file system. + 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 + content: {} + /api/2.23/policies/members: + get: + tags: + - Policies - Snapshot + summary: GET policies/members + description: | + List snapshot scheduling policies mapped to file systems, snapshots, and file system replica links. + Note: if more than 150,000 items would be returned in the response, an error will be thrown + and query parameters must be used to limit the items queried. + 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/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $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/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + 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/PolicyMemberWithRemoteGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberWithRemoteGetResponse' + /api/2.23/policies/file-system-replica-links: + get: + tags: + - Policies - Snapshot + summary: GET policies/file-system-replica-links + description: | + List snapshot scheduling policies for file system replica links. + Note: if more than 150,000 items would be returned in the response, an error will be thrown + and query parameters must be used to limit the items queried. + 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/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberWithRemoteGetResponse' + "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/PolicyMemberWithRemoteGetResponse' + post: + tags: + - Policies - Snapshot + summary: POST policies/file-system-replica-links + description: Add a snapshot scheduling policy to a file system replica link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberWithRemoteResponse' + delete: + tags: + - Policies - Snapshot + summary: DELETE policies/file-system-replica-links + description: Remove a snapshot scheduling policy mapped to a file system replica link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + responses: + "200": + description: OK + content: {} + /api/2.23/policies-all: + get: + tags: + - Policies (All) + summary: GET policies-all + description: List all policies of all types. + 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' + 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/PolicyBaseGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyBaseGetResponse' + /api/2.23/policies-all/members: + get: + tags: + - Policies (All) + summary: GET policies-all/members + description: | + List policies (of all types) mapped to other entities (file systems, + snapshots, file system replica links, and object store users). + Note: if more than 150,000 items would be returned in the response, an error will be thrown + and query parameters must be used to limit the items queried. + 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/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $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/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberWithRemoteGetResponse' + "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/PolicyMemberWithRemoteGetResponse' + /api/2.23/public-keys: + get: + tags: + - Public Keys + summary: List public key configurations + description: List public key configurations. + parameters: + - $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' + 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/PublicKeyGetResponse' + post: + tags: + - Public Keys + summary: Create public key configurations + description: Creates public key configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublicKeyPost' + required: true + x-codegen-request-body-name: public_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/PublicKeyResponse' + x-codegen-request-body-name: public_key + delete: + tags: + - Public Keys + summary: Delete public key configurations + description: Deletes public key configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/public-keys/uses: + get: + tags: + - Public Keys + summary: GET public-keys/uses + description: List how public keys are being used and by what. + parameters: + - $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' + 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/PublicKeyUseGetResponse' + /api/2.23/qos-policies: + get: + tags: + - Policies - QoS + summary: GET qos-policies + description: List QoS 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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/QosPoliciesGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/QosPoliciesGetResponse' + post: + tags: + - Policies - QoS + summary: POST qos-policies + description: Create a QoS policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QosPolicy' + required: true + x-codegen-request-body-name: policy + 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/QosPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - QoS + summary: DELETE qos-policies + description: Delete a QoS policy. + 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: + - Policies - QoS + summary: PATCH qos-policies + description: Modify a QoS policy. + 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/QosPolicy' + required: false + x-codegen-request-body-name: policy + 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/QosPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/qos-policies/file-systems: + get: + tags: + - Policies - QoS + summary: GET qos-policies/file-systems + description: List qos policies and their file system members. + 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' + 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/PolicyMemberContextGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + /api/2.23/qos-policies/members: + get: + tags: + - Policies - QoS + summary: GET qos-policies/members + description: List qos policies and their managed object members. + 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_qos' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/PolicyMemberContextGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + + post: + tags: + - Policies - QoS + summary: POST qos-policies/members + description: Map a managed object to a qos 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_qos_no_buckets' + - $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/PolicyMemberContextResponse' + + delete: + tags: + - Policies - QoS + summary: DELETE qos-policies/members + description: Remove the qos policy mapped to a managed object. + 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_qos_no_buckets' + - $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.23/qos-policies/buckets: + get: + tags: + - Policies - QoS + summary: GET qos-policies/buckets + description: List qos policies and their bucket members. + 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' + 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/PolicyMemberContextGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + /api/2.23/quotas/groups: + get: + tags: + - Quotas + summary: GET quotas/groups + description: List groups with hard limit quotas. + parameters: + - $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/Gids' + - $ref: '#/components/parameters/Group_names' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/GroupQuotaGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/GroupQuotaGetResponse' + post: + tags: + - Quotas + summary: POST quotas/groups + description: Create a hard limit quota for a group. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Gids' + - $ref: '#/components/parameters/Group_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GroupQuotaPost' + required: false + x-codegen-request-body-name: quota + 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/GroupQuotaResponse' + x-codegen-request-body-name: quota + delete: + tags: + - Quotas + summary: DELETE quotas/groups + description: Delete a hard limit quota for a group. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Gids' + - $ref: '#/components/parameters/Group_names' + - $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: + - Quotas + summary: PATCH quotas/groups + description: "Modify a quota for a group. Note that if you modify a group's quota to a lower value + and that group's usage has already exceeded the new value, writes will automatically halt until + usage decreases below the new quota setting." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Gids' + - $ref: '#/components/parameters/Group_names' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GroupQuotaPatch' + required: false + x-codegen-request-body-name: quota + 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/GroupQuotaResponse' + x-codegen-request-body-name: quota + /api/2.23/quotas/settings: + get: + tags: + - Quotas + summary: GET quotas-settings + description: List notification attributes of a group or user quota. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/json: + schema: + $ref: '#/components/schemas/QuotaSettingGetResponse' + patch: + tags: + - Quotas + summary: PATCH quotas-settings + description: Modify the notification attributes of a group or user quota. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QuotaSetting' + required: true + x-codegen-request-body-name: quota-setting + 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/QuotaSettingResponse' + x-codegen-request-body-name: quota-setting + /api/2.23/quotas/users: + get: + tags: + - Quotas + summary: GET quotas/users + description: List users with hard limit file system quotas. + parameters: + - $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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Uids' + - $ref: '#/components/parameters/User_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/UserQuotaGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UserQuotaGetResponse' + post: + tags: + - Quotas + summary: POST quotas/users + description: Create a hard limit file system quota for a user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Uids' + - $ref: '#/components/parameters/User_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserQuotaPost' + required: false + x-codegen-request-body-name: quota + 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/UserQuotaResponse' + x-codegen-request-body-name: quota + delete: + tags: + - Quotas + summary: DELETE quotas/users + description: Delete a hard limit file system quota for a user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Uids' + - $ref: '#/components/parameters/User_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: + - Quotas + summary: PATCH quotas/users + description: "Modify the attributes of a hard limit file system quota. Note that if you modify a + user's quota to a lower value and that user’s usage has already exceeded the new value, writes + will automatically halt until usage decreases below the new quota setting." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Uids' + - $ref: '#/components/parameters/User_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserQuotaPatch' + required: false + x-codegen-request-body-name: quota + 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/UserQuotaResponse' + x-codegen-request-body-name: quota + /api/2.23/presets/workload: + get: + tags: + - Presets + summary: List workload presets + description: | + Displays a list of workload presets. + parameters: + - $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: 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/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: Create a workload preset + description: | + Creates one workload preset. + parameters: + - $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: 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/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: 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/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.23/rapid-data-locking: + get: + tags: + - RDL + summary: Get the status of the Rapid Data Locking feature. + description: | + Displays the status of the Rapid Data Locking feature. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RapidDataLockingResponse' + patch: + tags: + - RDL + summary: Modifies the Rapid Data Locking feature. + description: | + Modifies the Rapid Data Locking feature. Note that the feature can only + be enabled if there are no file systems nor buckets created on the array. + Once enabled, the feature cannot be modified. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RapidDataLocking' + required: true + x-codegen-request-body-name: rapid-data-locking + 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/RapidDataLockingResponse' + x-codegen-request-body-name: rapid-data-locking + /api/2.23/rapid-data-locking/test: + get: + tags: + - RDL + summary: Displays Rapid Data Locking test results. + description: | + Displays a detailed result of a Rapid Data Locking test. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TestResultResponse' + /api/2.23/rapid-data-locking/rotate: + post: + tags: + - RDL + summary: Rotates the external keys on the associated EKM appliance. + description: | + Rotates the external keys on the associated EKM appliance. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/realms: + get: + tags: + - Realms + summary: GET realms + description: Displays a list of realms. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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_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/RealmGetResponse' + post: + tags: + - Realms + summary: POST realms + description: Create a new realm. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Without_default_access_list' + 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/RealmResponse' + delete: + tags: + - Realms + summary: DELETE Realms + description: | + Deletes a realm that has been destroyed and is pending eradication. + Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Realms + summary: PATCH realms + description: "Modify an existing realm's attributes, including destroying a realm." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $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.23/realms/defaults: + get: + tags: + - Realms + summary: GET realms/defaults + description: | + List of default configurations for realms. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Realm_ids' + - $ref: '#/components/parameters/Realm_names' + - $ref: '#/components/parameters/Sort' + 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/RealmDefaultsGetResponse' + + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RealmDefaultsGetResponse' + patch: + tags: + - Realms + summary: PATCH realms/defaults + description: | + Modify a default configuration for a realm. + parameters: + - $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/RealmDefaults' + required: true + x-codegen-request-body-name: default_realm_configuration + 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/RealmDefaultsResponse' + x-codegen-request-body-name: default_realm_configuration + /api/2.23/realms/space: + get: + tags: + - Realms + summary: GET realms/space + description: List used storage space for the realm. + parameters: + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/Total_only' + - $ref: '#/components/parameters/Type' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RealmSpaceGetResponse' + /api/2.23/realms/space/storage-classes: + get: + tags: + - Realms + summary: GET realms/space/storage-classes + description: List used storage space for storage classes in the realm. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/StorageClassNames' + - $ref: '#/components/parameters/Total_only' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RealmSpaceStorageClassGetResponse' + /api/2.23/remote-arrays: + get: + tags: + - Remote Arrays + summary: List remote arrays + description: |+ + Lists arrays in the current fleet, as well as arrays that the current array has existing + replication connections to. + + parameters: + - $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_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/RemoteArraysResponse' + /api/2.23/resiliency-groups: + get: + tags: + - Resiliency Groups + summary: GET resiliency-groups + description: Display all array resiliency groups. + parameters: + - $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' + 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/ResiliencyGroupGetResponse' + /api/2.23/resiliency-groups/members: + get: + tags: + - Resiliency Groups + summary: GET resiliency-groups/members + description: List membership associations between resiliency groups and nodes added to the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/Resiliency_group_ids' + - $ref: '#/components/parameters/Resiliency_group_names' + - $ref: '#/components/parameters/Sort' + 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/ResiliencyGroupMemberGetResponse' + /api/2.23/resource-accesses: + get: + tags: + - Resource Accesses + summary: GET resource-accesses + description: | + Returns a list of configured resource accesses. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit_scale' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/ResourceAccessesGetResponse' + delete: + tags: + - Resource Accesses + summary: DELETE resource-accesses + description: | + Delete resource access object. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/resource-accesses/batch: + post: + tags: + - Resource Accesses + summary: POST resource-accesses/batch + description: | + Create resource access objects. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ResourceAccessPost' + required: true + x-codegen-request-body-name: items + 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/ResourceAccessesResponse' + x-codegen-request-body-name: items + /api/2.23/roles: + get: + tags: + - Roles + summary: GET roles + description: List roles and permission attributes for role-based access control (RBAC). + parameters: + - $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' + 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/RoleGetResponse' + /api/2.23/s3-export-policies: + get: + tags: + - Policies - S3 Export + summary: GET s3-export-policies + description: | + List S3 export 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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/S3ExportPolicyGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/S3ExportPolicyGetResponse' + post: + tags: + - Policies - S3 Export + summary: POST s3-export-policies + description: | + Create a new S3 export policy. + + A non-empty list must be supplied in `servers`. The export is enabled + after creation by default, this can be changed by setting `export_enabled` + to `false`. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/S3ExportPolicyPost' + required: true + x-codegen-request-body-name: policy + 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/S3ExportPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - S3 Export + summary: DELETE s3-export-policies + description: | + Delete an S3 export policy. + 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: + - Policies - S3 Export + summary: PATCH s3-export-policies + description: | + Modify an existing S3 export policy. + 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/S3ExportPolicyPatch' + required: true + x-codegen-request-body-name: policy + 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/S3ExportPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/s3-export-policies/rules: + get: + tags: + - Policies - S3 Export + summary: GET s3-export-policies/rules + description: | + List rules for the specified S3 export policy. Currently, either + `policy_names` or `policy_ids` query parameters must be used and + contain exactly one element. + 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' + 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/S3ExportPolicyRuleGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/S3ExportPolicyRuleGetResponse' + post: + tags: + - Policies - S3 Export + summary: POST s3-export-policies/rules + description: | + Create a new rule for the specified S3 export policy. Either `policy_names` + or `policy_ids` query parameters can be used. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/S3ExportPolicyRulePost' + 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/S3ExportPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - S3 Export + summary: DELETE s3-export-policies/rules + description: | + Delete rules for the specified S3 export policy. Either `policy_names` + or `policy_ids` query parameters can be used. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + - $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: {} + patch: + tags: + - Policies - S3 Export + summary: PATCH s3-export-policies/rules + description: | + Modify rules of S3 export policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/S3ExportPolicyRulePost' + 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/S3ExportPolicyRuleResponse' + /api/2.23/sso/oidc/idps: + get: + tags: + - OIDC SSO + summary: List OIDC SSO configurations + description: Displays the OIDC SSO configuration settings in the array. + parameters: + - $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' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OidcSsoGetResponse' + post: + tags: + - OIDC SSO + summary: Create OIDC SSO configuration + description: Create OIDC SSO configuration. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OidcSsoPost' + required: true + x-codegen-request-body-name: idp + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OidcSsoResponse' + x-codegen-request-body-name: idp + delete: + tags: + - OIDC SSO + summary: Delete OIDC SSO configurations + description: Delete OIDC SSO configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + responses: + "200": + description: OK + content: {} + patch: + tags: + - OIDC SSO + summary: Modify OIDC SSO configuration + description: Modify one or more attributes of OIDC SSO configuration. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OidcSsoPatch' + required: true + x-codegen-request-body-name: idp + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OidcSsoResponse' + x-codegen-request-body-name: idp + /api/2.23/sso/saml2/idps: + get: + tags: + - SAML2 SSO + summary: List SAML2 SSO configurations + description: | + Displays the SAML2 SSO service provider and identity provider configuration + settings in the array. + parameters: + - $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' + 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/Saml2SsoGetResponse' + post: + tags: + - SAML2 SSO + summary: Create SAML2 SSO configurations + description: Creates SAML2 SSO configurations. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Saml2SsoResponse' + x-codegen-request-body-name: idp + delete: + tags: + - SAML2 SSO + summary: Delete SAML2 SSO configurations + description: Deletes SAML2 SSO configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - SAML2 SSO + summary: Modify SAML2 SSO configurations + description: Modifies one or more attributes of SAML2 SSO configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Saml2Sso' + required: true + x-codegen-request-body-name: idp + 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/Saml2SsoResponse' + x-codegen-request-body-name: idp + /api/2.23/sso/saml2/idps/test: + get: + tags: + - SAML2 SSO + summary: GET sso/saml2/idps/test + description: | + Test the existing SAML2 SSO configurations in the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + 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/TestResultResponse' + patch: + tags: + - SAML2 SSO + summary: PATCH sso/saml2/idps/test + description: | + Modifies and test 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/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Saml2Sso' + required: true + x-codegen-request-body-name: idp + 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/TestResultResponse' + x-codegen-request-body-name: idp + /api/2.23/storage-class-tiering-policies: + get: + tags: + - Policies - Storage Class Tiering + summary: GET storage-class-tiering-policies + description: List storage class tiering policies. + parameters: + - $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' + 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/StorageClassTieringPoliciesGetResponse' + post: + tags: + - Policies - Storage Class Tiering + summary: POST storage-class-tiering-policies + description: Create a storage class tiering policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StorageClassTieringPolicy' + required: false + x-codegen-request-body-name: policy + 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/StorageClassTieringPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Storage Class Tiering + summary: DELETE storage-class-tiering-policies + description: | + Delete a storage class tiering policy. + Deletion is not allowed if the policy is attached to one or more file systems. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Policies - Storage Class Tiering + summary: PATCH storage-class-tiering-policies + description: Modify a storage class tiering policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StorageClassTieringPolicy' + required: false + x-codegen-request-body-name: policy + 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/StorageClassTieringPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/storage-class-tiering-policies/members: + get: + tags: + - Policies - Storage Class Tiering + summary: GET storage-class-tiering-policies/members + description: List members mapped to a storage class tiering policy. + 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' + 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/StorageClassTieringPoliciesMembersGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/StorageClassTieringPoliciesMembersGetResponse' + /api/2.23/servers: + get: + tags: + - Servers + summary: GET servers + description: List servers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/ServerGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ServerGetResponse' + post: + tags: + - Servers + summary: POST servers + description: Add a server. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Create_ds' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServerPost' + required: true + x-codegen-request-body-name: server + 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/ServerResponse' + x-codegen-request-body-name: server + delete: + tags: + - Servers + summary: DELETE servers + description: Delete a server. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Cascade_delete' + - $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: + - Servers + summary: PATCH servers + description: Modify the server attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServerPost' + required: true + x-codegen-request-body-name: server + 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/ServerResponse' + x-codegen-request-body-name: server + /api/2.23/sessions: + get: + tags: + - Sessions + summary: List session data + description: "Displays session data for user login events performed in the Purity//FB GUI, CLI, + and REST API." + parameters: + - $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' + 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/SessionGetResponse' + /api/2.23/smb-client-policies: + get: + tags: + - Policies - SMB Client + summary: GET smb-client-policies + description: Display SMB Client policies 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/Workload_ids' + - $ref: '#/components/parameters/Workload_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/SmbClientPolicyGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SmbClientPolicyGetResponse' + post: + tags: + - Policies - SMB Client + summary: POST smb-client-policies + description: Create a new SMB Client policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmbClientPolicyPost' + required: false + x-codegen-request-body-name: policy + 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/SmbClientPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - SMB Client + summary: DELETE smb-client-policies + description: Delete one or more SMB Client policies. + 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: + - Policies - SMB Client + summary: PATCH smb-client-policies + description: Modify an existing SMB Client policy's attributes. + 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/SmbClientPolicyPatch' + required: true + x-codegen-request-body-name: policy + 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/SmbClientPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/smb-client-policies/rules: + get: + tags: + - Policies - SMB Client + summary: GET smb-client-policies/rules + description: | + Displays a list of SMB Client policy rules. + The default sort is by policy name, then index. + 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/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/SmbClientPolicyRuleGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SmbClientPolicyRuleGetResponse' + post: + tags: + - Policies - SMB Client + summary: POST smb-client-policies/rules + description: | + Add an SMB Client policy rule. + Rules are ordered in three groups; ip addresses, other and `*`. + The new rule will be added at the end of the appropriate group if neither + `before_rule_id` nor `before_rule_name` are specified. + Rules can only be inserted into the appropriate group. + The `policy_ids` or `policy_names` parameter is required, but they cannot be + set together. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmbClientPolicyRulePost' + 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/SmbClientPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - SMB Client + summary: DELETE smb-client-policies/rules + description: | + Delete one or more SMB Client policy rules. + One of the following is required: `ids` or `names`. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Policies - SMB Client + summary: PATCH smb-client-policies/rules + description: | + Modify an existing SMB Client policy rule. + If `before_rule_id` or `before_rule_name` are specified, the rule will be + moved before that rule. + Rules are ordered in three groups; ip addresses, other and `*` and can only + be moved within the appropriate group. + One of the following is required: `ids` or `names`. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmbClientPolicyRule' + 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/SmbClientPolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/smb-share-policies: + get: + tags: + - Policies - SMB Share + summary: GET smb-share-policies + description: Display SMB Share policies 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/Workload_ids' + - $ref: '#/components/parameters/Workload_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/SmbSharePolicyGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SmbSharePolicyGetResponse' + post: + tags: + - Policies - SMB Share + summary: POST smb-share-policies + description: Create a new SMB Share policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmbSharePolicyPost' + required: false + x-codegen-request-body-name: policy + 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/SmbSharePolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - SMB Share + summary: DELETE smb-share-policies + description: Delete one or more SMB Share policies. + 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: + - Policies - SMB Share + summary: PATCH smb-share-policies + description: Modify an existing SMB Share policy's attributes. + 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/SmbSharePolicyPatch' + required: true + x-codegen-request-body-name: policy + 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/SmbSharePolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/smb-share-policies/rules: + get: + tags: + - Policies - SMB Share + summary: GET smb-share-policies/rules + description: | + Displays a list of SMB Share policy rules. + 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/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/SmbSharePolicyRuleGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SmbSharePolicyRuleGetResponse' + post: + tags: + - Policies - SMB Share + summary: POST smb-share-policies/rules + description: | + Add an SMB Share policy rule. + The `policy_ids` or `policy_names` parameter is required, but they cannot be + set together. + parameters: + - $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/SmbSharePolicyRulePost' + 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/SmbSharePolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - SMB Share + summary: DELETE smb-share-policies/rules + description: | + Delete one or more SMB Share policy rules. + One of the following is required: `ids` or `names`. + If `names` is provided, the `policy_ids` or `policy_names` parameter is also required. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/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: {} + patch: + tags: + - Policies - SMB Share + summary: PATCH smb-share-policies/rules + description: | + Modify an existing SMB Share policy rule. + One of the following is required: `ids` or `names`. + If `names` is provided, the `policy_ids` or `policy_names` parameter is also required. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmbSharePolicyRule' + 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/SmbSharePolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/smtp-servers: + get: + tags: + - SMTP + summary: GET smtp-servers + description: List SMTP server attributes for the array network. + parameters: + - $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' + 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/SmtpServerGetResponse' + patch: + tags: + - SMTP + summary: PATCH smtp-servers + description: Modify SMTP server attributes such as the relay host and sender domain. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SmtpServerResponse' + x-codegen-request-body-name: smtp + /api/2.23/snmp-agents: + get: + tags: + - SNMP Agents + summary: GET snmp-agents + description: List SNMP agent attributes. + parameters: + - $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' + 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/SnmpAgentGetResponse' + patch: + tags: + - SNMP Agents + summary: PATCH snmp-agents + description: Modify SNMP agent attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnmpAgent' + required: true + x-codegen-request-body-name: snmp-agent + 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/SnmpAgentResponse' + x-codegen-request-body-name: snmp-agent + /api/2.23/snmp-agents/mib: + get: + tags: + - SNMP Agents + summary: GET snmp-agents-mib + description: | + List the SNMP MIB text. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SnmpAgentMibResponse' + /api/2.23/snmp-managers: + get: + tags: + - SNMP Managers + summary: GET snmp-managers + description: List SNMP managers and their attributes. + parameters: + - $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' + 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/SnmpManagerGetResponse' + post: + tags: + - SNMP Managers + summary: POST snmp-managers + description: Create an SNMP manager. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnmpManagerPost' + required: true + x-codegen-request-body-name: snmp-manager + 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/SnmpManagerResponse' + x-codegen-request-body-name: snmp-manager + delete: + tags: + - SNMP Managers + summary: DELETE snmp-managers + description: Remove an SNMP manager. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - SNMP Managers + summary: PATCH snmp-managers + description: Modify SNMP manager attributes such as versions. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnmpManager' + required: true + x-codegen-request-body-name: snmp-manager + 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/SnmpManagerResponse' + x-codegen-request-body-name: snmp-manager + /api/2.23/snmp-managers/test: + get: + tags: + - SNMP Managers + summary: GET snmp-managers/test + description: Test if the configuration of an SNMP manager is valid. + parameters: + - $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' + 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/TestResultGetResponse' + /api/2.23/ssh-certificate-authority-policies: + get: + tags: + - Policies - SSH Certificate Authority + summary: List SSH Certificate Authority configurations + description: List SSH Certificate Authority configurations + parameters: + - $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' + 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/SshCertificateAuthorityPolicyGetResponse' + post: + tags: + - Policies - SSH Certificate Authority + summary: Create SSH Certificate Authority configurations + description: Creates SSH Certificate Authority configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SshCertificateAuthorityPolicyPost' + required: true + x-codegen-request-body-name: policy + 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/SshCertificateAuthorityPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - SSH Certificate Authority + summary: Delete SSH Certificate Authority configurations + description: Deletes SSH Certificate Authority configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Policies - SSH Certificate Authority + summary: Modify SSH Certificate Authority configurations + description: Modifies one or more attributes of SSH Certificate Authority configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SshCertificateAuthorityPolicy' + required: true + x-codegen-request-body-name: policy + 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/SshCertificateAuthorityPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/ssh-certificate-authority-policies/admins: + get: + tags: + - Policies - SSH Certificate Authority + summary: GET ssh-certificate-authority-policies/admins + description: List SSH Certificate Authority policies mapped to specific users. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - SSH Certificate Authority + summary: POST ssh-certificate-authority-policies/admins + description: Map a SSH Certificate Authority policy to a specific user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - SSH Certificate Authority + summary: DELETE ssh-certificate-authority-policies/admins + description: Remove a SSH Certificate Authority policy from a specific user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/ssh-certificate-authority-policies/arrays: + get: + tags: + - Policies - SSH Certificate Authority + summary: GET ssh-certificate-authority-policies/arrays + description: List SSH Certificate Authority policies mapped as defaults for admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - SSH Certificate Authority + summary: POST ssh-certificate-authority-policies/arrays + description: Map a SSH Certificate Authority policy as a default for admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - SSH Certificate Authority + summary: DELETE ssh-certificate-authority-policies/arrays + description: Remove a SSH Certificate Authority policy from being a default for admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/ssh-certificate-authority-policies/members: + get: + tags: + - Policies - SSH Certificate Authority + summary: GET ssh-certificate-authority-policies/members + description: "List SSH Certificate Authority policies mapped to the admin default settings, or to + one or more specific users." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + /api/2.23/subnets: + get: + tags: + - Subnets + summary: GET subnets + description: List the array’s subnets. + parameters: + - $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' + 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/SubnetGetResponse' + post: + tags: + - Subnets + summary: POST subnets + description: Create an array subnet. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Subnet' + required: true + x-codegen-request-body-name: subnet + 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/SubnetResponse' + x-codegen-request-body-name: subnet + delete: + tags: + - Subnets + summary: DELETE subnets + description: Remove an array subnet. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Subnets + summary: PATCH subnets + description: Modify array subnet attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Subnet' + required: true + x-codegen-request-body-name: subnet + 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/SubnetResponse' + x-codegen-request-body-name: subnet + /api/2.23/support: + get: + tags: + - Support + summary: GET support + description: List Phone Home, Remote Assistance and Edge Management settings. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/json: + schema: + $ref: '#/components/schemas/SupportGetResponse' + patch: + tags: + - Support + summary: PATCH support + description: Modify Phone Home, Remote Assistance and Edge Management settings. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Support' + required: true + x-codegen-request-body-name: support + 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/SupportResponse' + x-codegen-request-body-name: support + /api/2.23/support/test: + get: + tags: + - Support + summary: GET support-test + description: Test if the Phone Home and Remote Assistance settings are functioning properly. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Test_type' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TestResultGetResponse' + /api/2.23/support/verification-keys: + get: + tags: + - Verification Keys + summary: GET verification-keys + description: | + List the key used to verify the signed challenges that are used by Pure Support + to access the FlashBlade. + parameters: + - $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' + 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/VerificationKeyGetResponse' + patch: + tags: + - Verification Keys + summary: PATCH verification-keys + description: | + Update the key used to verify the signed challenges that are used by Pure Support + to access the FlashBlade. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerificationKeyPatch' + required: true + x-codegen-request-body-name: 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/VerificationKeyResponse' + x-codegen-request-body-name: key + /api/2.23/support-diagnostics: + get: + tags: + - Support Diagnostics + summary: GET diagnostics list + description: | + Lists the support diagnostics tasks. + parameters: + - $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' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SupportDiagnosticsGetResponse' + post: + tags: + - Support Diagnostics + summary: Start a diagnostic task + description: | + Creates a diagnostics task for a given time interval. + If `start_time` is not provided, defaults to Current System Time - 1 hour. + If `end_time` is not provided, defaults to Current System Time. + If a task is already running, an error is returned. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Analysis_period_end_time' + - $ref: '#/components/parameters/Analysis_period_start_time' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SupportDiagnosticsGetResponse' + "403": + description: Another instance is already running + content: {} + /api/2.23/support-diagnostics/details: + get: + tags: + - Support Diagnostics + summary: GET diagnostics details + description: | + Lists the diagnostics tasks details. + parameters: + - $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' + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SupportDiagnosticsDetailsGetResponse' + /api/2.23/software-check: + get: + tags: + - Software + summary: List software check tasks + description: Displays a list of software check tasks. + parameters: + - $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: Create a software check task + description: | + Creates a software check task. + To create a task, use a software name and version. + If a task is already running, an error is returned. + parameters: + - $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' + "403": + description: Another instance is already running + content: {} + /api/2.23/syslog-servers: + get: + tags: + - Syslog + summary: GET syslog-servers + description: Return a list of configured syslog servers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names_for_syslog' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/SyslogServerGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerGetResponse' + post: + tags: + - Syslog + summary: POST syslog-servers + description: | + Configure a new syslog server. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_for_syslog' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerPost' + required: true + x-codegen-request-body-name: syslog-server + responses: + "200": + description: Returns the newly configured syslog server. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerResponse' + x-codegen-request-body-name: syslog-server + delete: + tags: + - Syslog + summary: DELETE syslog-servers + description: | + Delete a configured syslog server and stop forwarding syslog messages. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names_for_syslog' + responses: + "200": + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Syslog + summary: PATCH syslog-servers + description: Modify the URI or services of a configured syslog server. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names_for_syslog' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerPatch' + required: true + x-codegen-request-body-name: syslog-server + responses: + "200": + description: Returns the newly updated syslog server. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerResponse' + x-codegen-request-body-name: syslog-server + /api/2.23/syslog-servers/settings: + get: + tags: + - Syslog + summary: GET syslog-servers/settings + description: List the certificate or certificate group associated with the syslog servers. + parameters: + - $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' + 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/SyslogServerSettingsGetResponse' + patch: + tags: + - Syslog + summary: PATCH syslog-servers/settings + description: Modify the certificate or certificate group associated with the syslog servers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerSettings' + required: true + x-codegen-request-body-name: syslog-server-settings + 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/SyslogServerSettingsResponse' + x-codegen-request-body-name: syslog-server-settings + /api/2.23/syslog-servers/test: + get: + tags: + - Syslog + summary: GET syslog-servers/test + description: Send test messages to conifgured remote syslog servers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + 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/TestResultGetResponse' + /api/2.23/targets: + get: + tags: + - Targets + summary: GET targets + description: List targets used for replication. + 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' + 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/TargetGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TargetGetResponse' + post: + tags: + - Targets + summary: POST targets + description: Add a target for replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPost' + required: true + x-codegen-request-body-name: target + 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/TargetResponse' + x-codegen-request-body-name: target + delete: + tags: + - Targets + summary: DELETE targets + description: Delete the connection to the target for replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Targets + summary: PATCH targets + description: Modify the target attributes for replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Target' + required: true + x-codegen-request-body-name: target + 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/TargetResponse' + x-codegen-request-body-name: target + /api/2.23/targets/performance/replication: + get: + tags: + - Targets + summary: GET targets/performance/replication + description: List replication performance metrics for targets. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/ResourcePerformanceReplicationGetResponse' + /api/2.23/tls-policies: + get: + tags: + - Policies - TLS + summary: List TLS policies + description: List TLS policies + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Effective_tls_policy' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Purity_defined' + - $ref: '#/components/parameters/Sort' + 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/TlsPolicyGetResponse' + post: + tags: + - Policies - TLS + summary: Create TLS policies + description: Creates TLS policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TlsPolicyPost' + required: true + x-codegen-request-body-name: policy + 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/TlsPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - TLS + summary: Delete TLS policies + description: Deletes TLS policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Policies - TLS + summary: Modify TLS policies + description: Modifies one or more attributes of TLS policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TlsPolicy' + required: true + x-codegen-request-body-name: policy + 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/TlsPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/tls-policies/members: + get: + tags: + - Policies - TLS + summary: GET tls-policies/members + description: "List TLS policies mapped to the array as a whole, or to one or more specific objects + on the array (such as network interfaces)." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + /api/2.23/tls-policies/network-interfaces: + get: + tags: + - Policies - TLS + summary: GET tls-policies/network-interfaces + description: List network interface TLS policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - TLS + summary: POST tls-policies/network-interfaces + description: Apply a TLS policy to a specific network interface. A given network interface may only + have 1 TLS policy applied to it at any given time. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - TLS + summary: DELETE tls-policies/network-interfaces + description: Remove a TLS policy from a network interface. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/usage/groups: + get: + tags: + - Usage + summary: GET usage/groups + description: List groups with hard limit quotas and their file system 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/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Gids' + - $ref: '#/components/parameters/Group_names' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/GroupQuotaGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/GroupQuotaGetResponse' + /api/2.23/usage/users: + get: + tags: + - Usage + summary: GET usage/users + description: List users with hard limit quotas and their file system 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/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Uids' + - $ref: '#/components/parameters/User_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/UserQuotaGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UserQuotaGetResponse' + /api/2.23/workloads: + get: + tags: + - Workloads + summary: List workloads + description: | + Displays a list of workloads. + 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/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: Create a workload + description: | + Creates one workload. + parameters: + - $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: 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/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: 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/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.23/workloads/placement-recommendations: + get: + tags: + - Workloads + summary: List workload placement recommendations + description: Displays a list of placement recommendations for workloads. + parameters: + - $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: 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/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.23/workloads/tags: + get: + tags: + - Workloads + summary: List tags + description: Displays the list of tags. + parameters: + - $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: Delete tags + description: Deletes specified tags. + parameters: + - $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.23/workloads/tags/batch: + put: + tags: + - Workloads + summary: Update tags + description: Updates or creates tags for all specified objects. + parameters: + - $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 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 + /api/2.23/worm-data-policies: + get: + tags: + - Policies - WORM Data + summary: GET worm-data-policies + description: List WORM data 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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/WormDataPoliciesGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/WormDataPoliciesGetResponse' + post: + tags: + - Policies - WORM Data + summary: POST worm-data-policies + description: Create a WORM data policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WormDataPolicy' + required: false + x-codegen-request-body-name: policy + 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/WormDataPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - WORM Data + summary: DELETE worm-data-policies + description: | + Delete a WORM data policy. + Deletion is not allowed if the policy is attached to one or more file systems. + 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: + - Policies - WORM Data + summary: PATCH worm-data-policies + description: Modify a WORM data policy. + 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/WormDataPolicy' + required: false + x-codegen-request-body-name: policy + 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/WormDataPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/worm-data-policies/members: + get: + tags: + - Policies - WORM Data + summary: GET worm-data-policies/members + description: List members mapped to a WORM data policy. + 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' + 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/WormDataPoliciesMembersGetResponse' + "207": + description: | + Partial success. Some resources were returned, but there + were also errors possibly preventing some resources from + being returned. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/WormDataPoliciesMembersGetResponse' +components: + securitySchemes: + AuthorizationHeader: + type: apiKey + name: x-auth-token + in: header + ApiToken: + type: apiKey + name: api-token + in: header + 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_version: + type: object + properties: + versions: + $ref: '#/components/schemas/_api_versions' + Login: + type: object + properties: + username: + description: The username of the user. + type: string + example: pureuser + LoginBannerGetResponse: + type: object + properties: + login_banner: + description: The string to show as login banner. + type: string + example: Restricted area. Authorized personnel only. + ActiveDirectoryPost: + allOf: + - $ref: '#/components/schemas/ActiveDirectoryDirectoryServers' + - type: object + required: + - domain + - password + - user + properties: + computer_name: + description: | + The common 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: FLASHBLADE01 + directory_servers: + description: | + A list of directory servers that will be used for lookups related to user authorization. + Accepted server formats are IP address and DNS name. + All specified servers must be registered to the domain appropriately in the array's + configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. + If not specified, servers are resolved for the domain in DNS. + The specified list can have a maximum length of 5. + type: array + maxItems: 5 + items: + type: string + example: ldap.my-corporation.com + domain: + description: The Active Directory domain to join. + type: string + example: my-corporation.com + encryption_types: + description: | + The encryption types that will be supported for use by clients for Kerberos + authentication. + Defaults to `aes256-cts-hmac-sha1-96`. + Valid values include `aes256-cts-hmac-sha1-96`, `aes128-cts-hmac-sha1-96`, and + `arcfour-hmac`. + Cannot be provided if using an existing machine account. + type: array + items: + type: string + example: aes256-cts-hmac-sha1-96 + fqdns: + description: | + A list of fully qualified domain names to use to register service principal + names for the machine account. If specified, every service principal that + is supported by the array will be registered for each fully qualified domain + name specified. If neither `fqdns` nor `service_principal_names` is specified, + the default `service_principal_names` are constructed using + the `computer_name` and `domain` fields. + Cannot be provided in combination with `service_principal_names`. + Cannot be provided if using an existing machine account. + type: array + maxItems: 32 + items: + type: string + example: vip1.my-array.my-corporation.com + join_ou: + description: | + The relative distinguished name of the organizational unit in which the + computer account should be created when joining the domain. + Cannot be provided if using an existing machine account. + If not specified, defaults to `CN=Computers`. + type: string + example: CN=Computers + kerberos_servers: + description: | + A list of key distribution servers to use for Kerberos protocol. + Accepted server formats are IP address and DNS name. + All specified servers must be registered to the domain appropriately in the array's + configured DNS. + If not specified, servers are resolved for the domain in DNS. + The specified list can have a maximum length of 5. + type: array + maxItems: 5 + 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. If using an existing computer account, the user must have privileges to + read attributes from the computer account and reset the password on that account. + This is not persisted on the array. + type: string + example: Anything#but$adMinistrat0r + service_principal_names: + description: | + A list of service principal names to register for the machine account, + which can be used for the creation of keys for Kerberos authentication. + If neither `service_principal_names` nor `fqdns` is specified, + the default `service_principal_names` are constructed using + the `computer_name` and `domain` fields. + Cannot be provided in combination with `fqdns`. + Cannot be provided if using an existing machine account. + type: array + maxItems: 32 + items: + pattern: (service)/(fqdn) + type: string + example: nfs/vip1.my-array.my-corporation.com + user: + description: | + The login name of the user with privileges to create the computer account in + the domain. If using an existing computer account, the user must have privileges to + read attributes from the computer account and reset the password on that account. + This is not persisted on the array. + type: string + example: Administrator + ActiveDirectoryPatch: + allOf: + - $ref: '#/components/schemas/ActiveDirectoryDirectoryServers' + - type: object + properties: + directory_servers: + description: | + A list of directory servers that will be used for lookups related to user authorization. + Accepted server formats are IP address and DNS name. + All specified servers must be registered to the domain appropriately in the array's + configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. + If not specified, servers are resolved for the domain in DNS. + The specified list can have a maximum length of 5. + type: array + maxItems: 5 + items: + type: string + example: ldap.my-corporation.com + encryption_types: + description: | + The encryption types that will be supported for use by clients for Kerberos + authentication. + Valid values include `aes256-cts-hmac-sha1-96`, `aes128-cts-hmac-sha1-96`, and + `arcfour-hmac`. + type: array + items: + type: string + example: aes256-cts-hmac-sha1-96 + fqdns: + description: | + A list of fully qualified domain names to use to register service principal + names for the machine account. If specified, every service principal that + is supported by the array will be registered for each fully qualified domain + name specified. If neither `fqdns` nor `service_principal_names` is specified, + the default `service_principal_names` are constructed using + the `computer_name` and `domain` fields. + Cannot be provided in combination with `service_principal_names`. + type: array + maxItems: 32 + items: + type: string + example: vip1.my-array.my-corporation.com + join_ou: + description: | + The relative distinguished name of the organizational unit in which the + computer account should be created when joining the domain. + type: string + example: "OU=Purestorage,OU=StorageMachines" + kerberos_servers: + description: | + A list of key distribution servers to use for Kerberos protocol. + Accepted server formats are IP address and DNS name. + All specified servers must be registered to the domain appropriately in the array's + configured DNS. + If not specified, servers are resolved for the domain in DNS. + The specified list can have a maximum length of 5. + type: array + maxItems: 5 + items: + type: string + example: kdc.my-corporation.com + service_principal_names: + description: | + A list of service principal names to register for the machine account, + which can be used for the creation of keys for Kerberos authentication. + If neither `service_principal_names` nor `fqdns` is specified, + the default `service_principal_names` are constructed using + the `computer_name` and `domain` fields. + Cannot be provided in combination with `fqdns`. + type: array + maxItems: 32 + items: + pattern: (service)/(fqdn) + type: string + example: nfs/vip1.my-array.my-corporation.com + 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' + TestResultRemoteExecutionGet: + allOf: + - $ref: '#/components/schemas/TestResultRemoteExecution' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + total_item_count: + description: Total number of items after applying `filter` params. + type: integer + format: int32 + AdminPost: + description: | + An administrative user, who has rights to login and manage the array in some capacity. + type: object + properties: + management_access_policies: + description: | + List of management access policies associated with the administrator. + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + password: + description: New user password. + type: string + public_key: + description: Public key for SSH access. Supported key types include `Ed25519` and `RSA`. + type: string + role: + description: | + Deprecated. + `role` is deprecated in favor of `management_access_policies`, but remains for + backwards compatibility. If an administrator has exactly one access policy which + corresponds to a valid legacy role of the same name, `role` will be a + reference to that role. + Otherwise, it will be `null`. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + AdminPatch: + type: object + properties: + locked: + description: | + If set to `false`, the specified user is unlocked. + Setting to `true` is not allowed. + type: boolean + example: false + old_password: + description: Old user password. + type: string + password: + description: New user password. + type: string + public_key: + description: Public key for SSH access. Supported key types are `Ed25519` and `RSA`. + type: string + role: + description: | + Deprecated. + `role` is deprecated in favor of `management_access_policies`, but remains for + backwards compatibility. If an administrator has exactly one access policy which + corresponds to a valid legacy role of the same name, `role` will be a + reference to that role. + Otherwise, it will be `null`. If `role` is `null`, then attempts to patch it + will fail in order to prevent legacy operations from overwriting administrator + configurations utilizing newer policies. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + AdminGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AdminResponse' + - $ref: '#/components/schemas/_errorContextResponse' + AdminResponse: + type: object + properties: + items: + description: A list of administrative account objects. + type: array + items: + $ref: '#/components/schemas/Admin' + AdminApiTokenGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AdminApiTokenResponse' + AdminApiTokenResponse: + type: object + properties: + items: + description: A list of administrator API tokens. + type: array + items: + $ref: '#/components/schemas/AdminApiToken' + AdminCacheGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of admin cache entries. + type: array + items: + $ref: '#/components/schemas/AdminCache' + PolicyMemberGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyMemberResponse' + PolicyMemberResponse: + type: object + properties: + items: + description: A list of members for policies. + type: array + items: + $ref: '#/components/schemas/PolicyMember' + PolicyMemberContextGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyMemberContextResponse' + - $ref: '#/components/schemas/_errorContextResponse' + PolicyMemberContextResponse: + type: object + properties: + items: + description: A list of members for policies. + type: array + items: + $ref: '#/components/schemas/PolicyMemberContext' + AdminSetting: + type: object + properties: + lockout_duration: + description: | + The lockout duration, in milliseconds, if a user has reached the + maximum number of login attempts. Ranges from 1 second to 90 days. + Default value is `null`. Use 0 to reset the value to `null`. + type: integer + format: int64 + minimum: 0 + maximum: 7776000000 + example: 3600000 + max_login_attempts: + description: | + The maximum number of failed login attempts allowed before the user is locked out. + Default value is `null`. Use 0 to reset the value to `null`. + type: integer + format: int32 + minimum: 0 + maximum: 100 + example: 10 + min_password_length: + description: | + The minimum password length. If not specified, defaults to 1 character. + type: integer + format: int32 + minimum: 1 + maximum: 100 + example: 1 + AdminSettingsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AdminSettingsResponse' + AdminSettingsResponse: + type: object + properties: + items: + description: Returns global admin settings. + type: array + items: + $ref: '#/components/schemas/AdminSetting' + Alert: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + action: + description: The action of the alert. + type: string + readOnly: true + code: + description: Alert code. + type: integer + format: int64 + readOnly: true + component_name: + description: The component name of the alert. + type: string + readOnly: true + component_type: + description: The component type of the alert. + type: string + readOnly: true + created: + description: The creation timestamp of the alert. + type: integer + format: int64 + readOnly: true + description: + description: The description of the alert. + type: string + readOnly: true + duration: + description: The duration of the alert. + type: integer + format: int64 + readOnly: true + flagged: + description: Flagged state of the alert. + type: boolean + index: + description: The unique index of the alert. + type: integer + format: int64 + readOnly: true + knowledge_base_url: + description: URL of the relevant Knowledge Base page. + type: string + readOnly: true + notified: + description: The last notification timestamp of the alert. + type: integer + format: int64 + readOnly: true + severity: + description: | + Severity of the alert. + Valid values are `info`, `warning`, and `critical`. + type: string + readOnly: true + state: + description: | + The current state of the alert. + Valid values are `open`, `closing`, `closed`, and + `waiting to downgrade`. + type: string + readOnly: true + summary: + description: The summary of the alert. + type: string + readOnly: true + updated: + description: The last updated timestamp of the alert. + type: integer + format: int64 + readOnly: true + variables: + description: Key-value pairs of additional information of the alert. + type: object + readOnly: true + additionalProperties: + type: string + AlertGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AlertResponse' + AlertResponse: + type: object + properties: + items: + description: A list of alert objects. + type: array + items: + $ref: '#/components/schemas/Alert' + AlertWatcherPost: + type: object + properties: + minimum_notification_severity: + description: | + The minimum severity that an alert must have in order for emails to + be sent to the watcher. + Possible values include `info`, `warning`, and `critical`. + If not specified, defaults to `info`. + type: string + AlertWatcher: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + enabled: + description: | + Is email notification enabled? If not specified, defaults to `true`. + type: boolean + minimum_notification_severity: + description: | + The minimum severity that an alert must have in order for emails to + be sent to the watcher. + Possible values include `info`, `warning`, and `critical`. + type: string + 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' + TestResultResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/TestResult' + ApiClientsPost: + type: object + required: + - public_key + 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/_referenceWritable' + access_token_ttl_in_ms: + description: | + The TTL (Time To Live) duration for which the exchanged access token is valid. + 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 a client has exactly one access policy which corresponds to a + valid legacy role of the same name, `max_role` will be a reference to that role. + Otherwise, it will be `null`. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + public_key: + description: | + The API client's PEM formatted (Base64 encoded) RSA public key. + It must 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----- + ApiClient: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: | + API client used for OAuth. + 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/_fixedReference' + readOnly: true + access_token_ttl_in_ms: + description: | + The TTL (Time To Live) duration for which the exchanged access token is valid. + 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 + example: true + 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: http://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: | + 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 a reference to that role. + Otherwise, it will be `null`. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + 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----- + ApiClientsResponse: + type: object + properties: + items: + description: A list of API client objects. + type: array + items: + $ref: '#/components/schemas/ApiClient' + Array: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/_context' + - type: object + properties: + _as_of: + description: Array time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + banner: + description: | + A string to be shown when logging in to the array. + type: string + example: Restricted area. Authorized personnel only. + default_inbound_tls_policy: + description: | + The default TLS policy governing inbound traffic from clients accessing the array. + This TLS policy will be applied for any IP addresses on the system that do not + have a specific policy applied to them at a more granular level. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + encryption: + readOnly: true + title: ArrayEncryption + allOf: + - $ref: '#/components/schemas/_arrayEncryption' + eradication_config: + title: ArrayEradicationConfig + allOf: + - $ref: '#/components/schemas/_arrayEradicationConfig' + idle_timeout: + description: | + Idle timeout in milliseconds. Valid values are + in the range of 300000 and 10800000. Setting this value to 0 + disables timeouts. + type: integer + format: int32 + example: 300000 + network_access_policy: + description: | + The network access policy governing which clients are allowed or denied access to different + array interfaces. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + ntp_servers: + type: array + items: + type: string + example: time.acme.com + os: + description: | + Valid values are `Purity//FA` and `Purity//FB`. + type: string + readOnly: true + example: Purity//FB + product_type: + description: | + For `FlashBlade//S` arrays, the value is determined by the blades in the system. + The value will be `FlashBlade` for all older arrays. + Valid values are `FlashBlade`, `FlashBlade//S`, `FlashBlade//S200`, and `FlashBladeS500`. + type: string + readOnly: true + revision: + type: string + readOnly: true + example: 2017.11.07_8f3ab6f5 + security_update: + description: | + The name of the installed security update that currently applies to the system. + This field will be `null` if either no security update has been installed, or if the + most recently installed security update is no longer needed by the current + FlashBlade software due to the current software fully incorporating the update. + type: string + readOnly: true + example: fb-2022-04-04 + smb_mode: + description: | + The current SMB mode of the array. + This controls the type of authentication that is used by the array for SMB. + Possible values include `ad-auto`, `ad-rfc2307`, `guest`, and `native`. + Modifying this value requires the assistance of Pure Storage Support. + type: string + readOnly: true + time_zone: + description: | + The time zone to use for the array. In particular this affects + the CLI formatting and the default snapshot policy time zone. + type: string + example: America/Los_Angeles + version: + type: string + readOnly: true + example: 2.1.0 + ArrayGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ArrayResponse' + - $ref: '#/components/schemas/_errorContextResponse' + ArrayResponse: + type: object + properties: + items: + description: A list of array objects. + type: array + items: + $ref: '#/components/schemas/Array' + ClientsPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of client performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ClientsPerformance' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/ClientsPerformance' + - $ref: '#/components/schemas/_errorContextResponse' + ClientsS3SpecificPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of S3 specific array performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ClientsS3SpecificPerformance' + total: + description: Total of all records after filtering. If `total_only` query param is `true`, + then no items will be returned. + type: array + items: + $ref: '#/components/schemas/ClientsS3SpecificPerformance' + 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' + ArrayConnectionPost: + allOf: + - $ref: '#/components/schemas/ArrayConnection' + - type: object + properties: + connection_key: + description: | + The connection key of the target array. Settable on POST only. + type: string + example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 + encrypted: + description: | + If this is set to `true`, then all customer data replicated over + the connection will be sent over an encrypted connection using TLS, + or will not be sent if a secure connection cannot be + established. + If this is set to `false`, then all customer data replicated over + the connection will be sent over an unencrypted connection. + Defaults to `false`. + type: boolean + throttle: + $ref: '#/components/schemas/_throttle' + ArrayConnection: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - $ref: '#/components/schemas/_context' + - description: | + Connection to a target array. + type: object + properties: + ca_certificate_group: + description: | + The group of CA certificates that can be used, in addition to + well-known Certificate Authority certificates, in order to + establish a secure connection to the target array. + Defaults to a reference to the `_default_replication_certs` group + if `secure_connection` is `true`, or `null` otherwise. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + encrypted: + description: | + If this is set to `true`, then all customer data replicated over + the connection will be sent over an encrypted connection using TLS, + or will not be sent if a secure connection cannot be + established. + If this is set to `false`, then all customer data replicated over + the connection will be sent over an unencrypted connection. + Defaults to `false`. + type: boolean + management_address: + description: | + Management address of the target array. Settable on POST only. + 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: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + replication_addresses: + description: | + IP addresses and/or FQDNs of the target arrays. Settable on POST only. + If not set on POST, 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 + status: + description: | + Status of the connection. + Valid values include `connected`, `partially_connected`, `connecting`, + and `incompatible`. + `connected` - The connection is OK. + `partially_connected` - Some replication addresses are working, + but others are not. + `connecting` - No connection exists and the array is trying to + reconnect. + `incompatible` - The target array is not compatible. + type: string + readOnly: true + throttle: + $ref: '#/components/schemas/_throttle' + type: + description: | + The type of connection. Valid values include `async-replication` and `fleet-management`. + type: string + readOnly: true + version: + description: The version of the target array. + type: string + readOnly: true + example: 2.3.0 + 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' + - $ref: '#/components/schemas/ArrayConnectionKeyResponse' + ArrayConnectionKeyResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ArrayConnectionKey' + ArrayConnectionPathGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ArrayConnectionPath' + ConnectionRelationshipPerformanceReplicationGetResp: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ConnectionRelationshipPerformanceReplication' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/ConnectionRelationshipPerformanceReplication' + ArrayHttpSpecificPerformanceGet: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + description: A list of http specific array performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ArrayHttpSpecificPerformance' + ArrayNfsSpecificPerformanceGet: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + description: A list of NFS specific array performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ArrayNfsSpecificPerformance' + ArrayPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + description: A list of array performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ArrayPerformance' + ArrayPerformanceReplicationGetResp: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/RelationshipPerformanceReplication' + ArrayS3SpecificPerformanceGetResp: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + description: A list of S3 specific array performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ArrayS3SpecificPerformance' + ArraySpaceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + description: A list of array space metrics objects. + type: array + items: + $ref: '#/components/schemas/ArraySpace' + ArraySpaceStorageClassGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of array space metrics objects for each storage class. + type: array + items: + $ref: '#/components/schemas/StorageClassSpace' + total: + $ref: '#/components/schemas/StorageClassSpace' + ArraysSupportedTimeZonesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/_timeZone' + ArrayErasureResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ArrayErasure' + ArrayErasureGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ArrayErasureResponse' + AuditGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditResponse' + AuditFileSystemsPoliciesPost: + allOf: + - $ref: '#/components/schemas/AuditFileSystemsPolicyNoContext' + AuditFileSystemsPoliciesPatch: + allOf: + - $ref: '#/components/schemas/AuditFileSystemsPolicyPatchBase' + - type: object + properties: + add_log_targets: + description: | + The log targets which will be added to the existing `log_targets` list for the + audit policy. These new log targets will be appended to the end of the existing list. + The `add_log_targets` field can not be used with `log_targets` field. + type: array + items: + $ref: '#/components/schemas/_reference' + remove_log_targets: + description: | + The log targets which will be removed from the existing `log_targets` list for the + audit policy. The `remove_log_targets` field can not be used with `log_targets` field. + type: array + items: + $ref: '#/components/schemas/_reference' + AuditFileSystemsPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditFileSystemsPoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + AuditFileSystemsPoliciesResponse: + type: object + properties: + items: + description: A list of audit policy objects. + type: array + items: + $ref: '#/components/schemas/AuditFileSystemsPolicy' + AuditFileSystemsPoliciesMembersGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditFileSystemsPoliciesMembersResponse' + - $ref: '#/components/schemas/_errorContextResponse' + AuditFileSystemsPoliciesMembersResponse: + type: object + properties: + items: + description: A list of members for audit policies. + type: array + items: + $ref: '#/components/schemas/PolicyMemberContext' + AuditFileSystemsPolicyOperationGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditFileSystemsPolicyOperationResponse' + AuditObjectStorePoliciesPost: + allOf: + - $ref: '#/components/schemas/AuditObjectStorePolicyWithWritableReference' + AuditObjectStorePoliciesPatch: + allOf: + - $ref: '#/components/schemas/AuditObjectStorePolicy' + - type: object + properties: + add_log_targets: + description: | + The log targets which will be added to the existing `log_targets` list for the + audit policy. These new log targets will be appended to the end of the existing list. + The `add_log_targets` field cannot be used with the `log_targets` field. + type: array + items: + $ref: '#/components/schemas/_reference' + remove_log_targets: + description: | + The log targets which will be removed from the existing `log_targets` list for the + audit policy. The `remove_log_targets` field cannot be used with the `log_targets` field. + type: array + items: + $ref: '#/components/schemas/_reference' + AuditObjectStorePoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditObjectStorePoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + AuditObjectStorePoliciesResponse: + type: object + properties: + items: + description: A list of audit policy objects. + type: array + items: + $ref: '#/components/schemas/AuditObjectStorePolicyWithContext' + AuditObjectStorePoliciesMembersGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditObjectStorePoliciesMembersResponse' + - $ref: '#/components/schemas/_errorContextResponse' + AuditObjectStorePoliciesMembersResponse: + type: object + properties: + items: + description: A list of members for audit object policies. + type: array + items: + $ref: '#/components/schemas/PolicyMemberContext' + BladeGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of blade objects. + type: array + items: + $ref: '#/components/schemas/Blade' + total: + type: object + allOf: + - $ref: '#/components/schemas/Blade' + - description: | + If `total_only` query param is `true`, then it 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 + BucketAuditFilterActionGetResponse: + allOf: + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/BucketAuditFilterActionResponse' + BucketPost: + type: object + properties: + account: + description: The account name for bucket creation. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + bucket_type: + description: | + The bucket type for the bucket. Valid values are `classic`, and `multi-site-writable`. + Default value is `multi-site-writable`. + type: string + eradication_config: + $ref: '#/components/schemas/_bucketEradicationConfig' + hard_limit_enabled: + description: | + If set to `true`, the bucket's size, as defined by `quota_limit`, + is used as a hard limit quota. + If set to `false`, a hard limit quota will not be applied to the + bucket, but soft quota alerts will still be sent if the bucket has + a value set for `quota_limit`. + If not specified, defaults to the value + of `bucket_defaults.hard_limit_enabled` of the object store account this + bucket is associated with. + type: boolean + object_lock_config: + $ref: '#/components/schemas/_objectLockConfigRequestBody' + quota_limit: + description: | + The effective quota limit applied against the size of the bucket, displayed in bytes. + If set to an empty string (`""`), the bucket is unlimited in size. If not specified, + defaults to the value of `bucket_defaults.quota_limit` of the object + store account this bucket is associated with. + type: string + retention_lock: + description: | + If set to `ratcheted`, then `object_lock_config.default_retention_mode` + cannot be changed if set to `compliance`. In this case, the value of + `object_lock_config.default_retention` can only be increased and + `object_lock_config.default_retention_mode` cannot be changed once set + to `compliance`. + Valid values are `unlocked` and `ratcheted`. + If not specified, defaults to `unlocked`. + type: string + example: unlocked + BucketPatch: + type: object + properties: + destroyed: + description: | + Is the bucket destroyed? + type: boolean + eradication_config: + $ref: '#/components/schemas/_bucketEradicationConfig' + hard_limit_enabled: + description: | + If set to `true`, the bucket's size, as defined by `quota_limit`, + is used as a hard limit quota. + If set to `false`, a hard limit quota will not be applied to the + bucket, but soft quota alerts will still be sent if the bucket has + a value set for `quota_limit`. + type: boolean + object_lock_config: + $ref: '#/components/schemas/_objectLockConfigRequestBody' + public_access_config: + $ref: '#/components/schemas/_publicAccessConfig' + qos_policy: + description: | + The QoS policy for the bucket defines the performance controls + that can be applied to the aggregate performance of all the clients + accessing the bucket. + If no policy is set here, no explicit performance controls are applied + to the bucket beyond the system's default fairness. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + quota_limit: + description: | + The effective quota limit applied against the size of the bucket, displayed in bytes. + If set to an empty string (`""`), the bucket is unlimited in size. + type: string + retention_lock: + description: | + If set to `ratcheted`, then `object_lock_config.default_retention_mode` + cannot be changed if set to `compliance`. In this case, the value of + `object_lock_config.default_retention` can only be increased and + `object_lock_config.default_retention_mode` cannot be changed once set + to `compliance`. + Valid values are `unlocked` and `ratcheted`. + Contact Pure Technical Services to change `ratcheted` to `unlocked`. + type: string + example: unlocked + storage_class: + $ref: '#/components/schemas/StorageClassInfo' + versioning: + description: | + The versioning state for objects within the bucket. + Valid values are `none`, `enabled`, and `suspended`. + type: string + BucketGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/BucketResponse' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + total: + $ref: '#/components/schemas/Bucket' + BucketResponse: + type: object + properties: + items: + description: A list of bucket objects. + type: array + items: + $ref: '#/components/schemas/Bucket' + BucketAuditFilterPost: + description: The audit filter object. + allOf: + - $ref: '#/components/schemas/BucketAuditFilterBase' + BucketAuditFilterGetResponse: + allOf: + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/BucketAuditFilterResponse' + BucketAuditFilterResponse: + type: object + properties: + items: + description: A list of audit filters. + type: array + items: + $ref: '#/components/schemas/BucketAuditFilterWithContext' + CrossOriginResourceSharingPolicyPatch: + type: object + properties: + rules: + type: array + items: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleBulkManage' + CrossOriginResourceSharingPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyResponse' + CrossOriginResourceSharingPolicyResponse: + type: object + properties: + items: + description: A list of cross origin resource sharing policy objects. + type: array + items: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicy' + CrossOriginResourceSharingPolicyRulePost: + type: object + properties: + allowed_headers: + description: | + A list of headers that are permitted to be included in cross-origin requests to + access a bucket. The only currently supported allowed header is `*`. + type: array + items: + type: string + example: + - '*' + allowed_methods: + description: | + A list of HTTP methods that are permitted for cross-origin requests to access a bucket. + The only currently supported combination of allowed methods is all methods + `["GET", "PUT", "HEAD", "POST", "DELETE"]`. + type: array + items: + type: string + example: + - GET + - PUT + - HEAD + - POST + - DELETE + allowed_origins: + description: | + A list of origins (domains) that are permitted to make cross-origin requests to + access a bucket. The only currently supported allowed origin is `*`. + type: array + items: + type: string + example: + - '*' + CrossOriginResourceSharingPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleResponse' + CrossOriginResourceSharingPolicyRuleResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleWithContext' + BucketPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of bucket performance objects. + type: array + items: + $ref: '#/components/schemas/BucketPerformanceItems' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/BucketPerformance' + BucketAccessPolicyPost: + type: object + properties: + rules: + type: array + items: + $ref: '#/components/schemas/BucketAccessPolicyRuleBulkManage' + BucketAccessPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/BucketAccessPolicyResponse' + BucketAccessPolicyResponse: + type: object + properties: + items: + description: A list of bucket policy objects. + type: array + items: + $ref: '#/components/schemas/BucketAccessPolicy' + BucketAccessPolicyRulePost: + type: object + properties: + actions: + description: | + The list of actions granted by this rule. Each included action may + restrict other properties of the rule. + The only currently supported action is `s3:GetObject`. + type: array + items: + type: string + example: + - s3:GetObject + 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. + The only currently supported effect is `allow`. + type: string + readOnly: true + example: allow + principals: + description: | + The principals to which this rule applies. Currently, only all principals are supported. + title: BucketAccessPolicyRulePrincipal + allOf: + - $ref: '#/components/schemas/BucketAccessPolicyRulePrincipal' + resources: + description: | + The list of resources which this rule applies to. + The only currently supported resource is all objects in a bucket to which + the parent policy belongs. + type: array + items: + type: string + example: + - mybucket/* + BucketAccessPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/BucketAccessPolicyRuleResponse' + BucketAccessPolicyRuleResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/BucketAccessPolicyRuleWithContext' + BucketS3SpecificPerformanceGetResp: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of S3 specific bucket performance metrics objects. + type: array + items: + $ref: '#/components/schemas/BucketS3SpecificPerformance' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/BucketS3SpecificPerformance' + BucketReplicaLinkPost: + type: object + properties: + cascading_enabled: + description: | + If set to `true`, objects replicated to this bucket via a replica + link from another array will also be replicated by this link to + the remote bucket. + Defaults to `false`. + type: boolean + paused: + description: Create link in the paused state? Defaults to `false`. + type: boolean + BucketReplicaLink: + allOf: + - $ref: '#/components/schemas/_replicaLinkBuiltIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + cascading_enabled: + description: | + If set to `true`, objects replicated to this bucket via a replica + link from another array will also be replicated by this link to + the remote bucket. + Defaults to `false`. + type: boolean + readOnly: true + local_bucket: + description: | + Reference to a local bucket. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + object_backlog: + description: | + The number of pending operations and their size that are currently in the backlog. + title: ObjectBacklog + allOf: + - $ref: '#/components/schemas/_objectBacklog' + paused: + description: Is the replica link paused? + type: boolean + recovery_point: + description: | + Time, in milliseconds since UNIX epoch, where all object changes before this time are + guaranteed to have been replicated. Changes after this time may have been replicated. + type: integer + format: int64 + readOnly: true + example: 1565034592494 + remote: + description: | + Reference to the associated remote, which can either be a `target` or remote `array`. + If it is an `array`, then the `resource-type` field will not be populated. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + remote_bucket: + description: Reference to a remote bucket. + title: FixedReferenceNameOnly + allOf: + - $ref: '#/components/schemas/_fixedReferenceNameOnly' + remote_credentials: + description: | + Reference to a remote-credentials object to access the remote bucket. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + status: + description: | + Status of the replica link. + Values include `replicating`, `paused`, and `unhealthy`. + type: string + readOnly: true + BucketReplicaLinkGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/BucketReplicaLinkResponse' + BucketReplicaLinkResponse: + type: object + properties: + items: + description: A list of object store bucket replica link objects. + type: array + items: + $ref: '#/components/schemas/BucketReplicaLink' + total: + description: | + If `total_only` query param is `true`, then it 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. + title: BucketReplicaLink + allOf: + - $ref: '#/components/schemas/BucketReplicaLink' + 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 + passphrase: + description: | + The passphrase used to encrypt `private_key`. + This field can only be specified when importing a certificate and key pair. + type: string + private_key: + description: | + The text of the private key. + This field can only be specified when importing a certificate and key pair. + type: string + CertificatePatch: + 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 + passphrase: + description: | + The passphrase used to encrypt `private_key`. + This field can only be specified when importing a certificate and key pair. + type: string + private_key: + description: | + The text of the private 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: + description: A list of certificate objects. + type: array + items: + $ref: '#/components/schemas/Certificate' + CertificateCertificateGroupGetResp: + 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/Member' + CertificateSigningRequestPost: + description: A request to create a CSR for a Purity//FB certificate object. + type: object + properties: + certificate: + description: | + The certificate object whose private key will be used for generating the CSR, + and whose certificate will be overwritten if the CSR is signed and + imported back into FlashBlade. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + common_name: + description: The common name field to be listed in the certificate. + type: string + example: Pure Storage Inc. + country: + description: Two-letter country (ISO) code to be listed in the certificate. + type: string + example: CA + email: + description: The email field to be listed in the certificate. + type: string + example: tcrisp@veridiandynamics.com + locality: + description: The locality field to be listed in the certificate. + type: string + example: Toronto + organization: + description: The organization field to be listed in the certificate. + type: string + example: Veridian Dynamics + organizational_unit: + description: The organizational unit field to be listed in the certificate. + type: string + example: Research & Development + state: + description: The state/province field to be listed in the certificate. + type: string + example: Ontario + subject_alternative_names: + description: | + The alternative names that are secured by this certificate. + Alternative names may be IP addresses, DNS names, or URIs. + Specifying these will encode them in the certificate signing + request; however, it is the decision of the signing authority + as to whether or not they will be honored or ignored. + type: array + items: + type: string + example: "otherdnsname.mydomain.com" + CertificateSigningRequestResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/CertificateSigningRequest' + description: A list of certificate signing request objects. + 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' + CertificateGroupCertificateGetResp: + 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/Member' + 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' + DataEvictionPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + keep_size: + description: | + The maximum physical data space (in bytes) of a target + file system before least recently read data is evicted. + type: integer + format: int64 + DataEvictionPolicy: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/PolicyBaseRenameable' + - type: object + properties: + keep_size: + description: | + The maximum physical data space(in bytes) of a target + file system to have no non-expired data evicted. + type: integer + format: int64 + DataEvictionPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/DataEvictionPoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + DataEvictionPoliciesResponse: + type: object + properties: + items: + description: A list of Data Eviction policy objects. + type: array + items: + $ref: '#/components/schemas/DataEvictionPolicy' + DataEvictionPoliciesMembersGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/DataEvictionPoliciesMembersResponse' + - $ref: '#/components/schemas/_errorContextResponse' + DataEvictionPoliciesMembersResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/PolicyMemberContext' + description: A list of members for data eviction policies. + DirectoryService: + allOf: + - $ref: '#/components/schemas/_builtIn' + - 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: Obfuscated 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" + ca_certificate: + description: | + CA certificate used to validate the authenticity of the configured + servers. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + ca_certificate_group: + description: | + A certificate group containing CA certificates that can be used to + validate the authenticity of the configured servers. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + enabled: + description: Is the directory service enabled or not? + type: boolean + example: true + management: + $ref: '#/components/schemas/_directoryServiceManagement' + nfs: + $ref: '#/components/schemas/_directoryServiceNfs' + services: + description: | + Services that the directory service configuration is used for. + type: array + readOnly: true + items: + type: string + description: | + Valid values include `nfs` and `management`. + example: management + example: + - management + smb: + $ref: '#/components/schemas/_directoryServiceSmb' + uris: + description: List of URIs for the configured directory servers. + type: array + maxItems: 30 + items: + pattern: ^(ldap|ldaps) + type: string + example: ldaps://ad1.mycompany.com + DirectoryServiceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/DirectoryServiceResponse' + DirectoryServiceResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/DirectoryService' + DirectoryServiceRolePost: + type: object + properties: + group: + description: | + Common Name (CN) of the directory service group containing + users with authority level of the specified role name. + 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 directory service role. + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + role: + description: | + Deprecated. + `role` is deprecated in favor of `management_access_policies`, but remains for + backwards compatibility. If a directory service role has exactly one access + policy, which corresponds to a valid legacy role of the same name, + `role` will be a reference to that role. + Otherwise, it will be `null`. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + DirectoryServiceRole: + type: object + properties: + group: + description: | + Common Name (CN) of the directory service group containing + users with authority level of the specified role name. + 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" + id: + description: | + A non-modifiable, globally unique ID chosen by the system. + type: string + readOnly: true + management_access_policies: + description: | + List of management access policies associated with the directory service role. + readOnly: true # Prevent Patch calls. Use policies sub-endpoint instead. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + name: + description: Name of the role mapping object. + type: string + readOnly: true + role: + description: | + Deprecated. + `role` is deprecated in favor of `management_access_policies`, but remains for + backwards compatibility. If a directory service role has exactly one access + policy, which corresponds to a valid legacy role of the same name, + `role` will be a reference to that role. + Otherwise, it will be `null`. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + DirectoryServiceRolesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/DirectoryServiceRolesResponse' + DirectoryServiceRolesResponse: + type: object + properties: + items: + description: A list of directory service role mapping configuration objects. + type: array + items: + $ref: '#/components/schemas/DirectoryServiceRole' + TestResultRemoteExecution: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/TestResultWithContext' + DnsPost: + type: object + properties: + domain: + description: | + Domain suffix to be appended by the appliance when performing DNS lookups. + type: string + example: example.com + nameservers: + description: List of DNS server IP addresses. + type: array + maxItems: 3 + items: + type: string + example: "" + services: + description: | + The list of services utilizing the DNS configuration. + type: array + items: + type: string + description: | + Valid values include `management` and `data`. + sources: + description: | + The network interfaces used for communication with the DNS server. + The network interfaces must have the `services` value of `data` or `egress-only`. + Clear this by setting an empty list. + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/_reference' + Dns: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/DnsPost' + - type: object + properties: + realms: + description: | + The realms containing this DNS. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + DnsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/DnsResponse' + DnsResponse: + type: object + properties: + items: + description: A list of dns objects. + type: array + items: + $ref: '#/components/schemas/Dns' + DriveGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of drive objects. + type: array + items: + $ref: '#/components/schemas/Drive' + total: + type: object + allOf: + - $ref: '#/components/schemas/Drive' + - description: | + If `total_only` query param is `true`, then it 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 + FileSystemPost: + type: object + properties: + default_group_quota: + description: The default space quota for a group writing to this file system. + type: integer + format: int64 + default_user_quota: + description: The default space quota for a user writing to this file system. + type: integer + format: int64 + eradication_config: + $ref: '#/components/schemas/_fileSystemEradicationConfig' + fast_remove_directory_enabled: + description: | + If set to `true`, the file system, when mounted, will contain a + directory that can be used for fast removal of other directories. + Directories can be moved into the fast remove directory in order + to have them deleted, and their space freed, more quickly than a + normal removal operation. + If not specified, defaults to `false`. + type: boolean + group_ownership: + description: | + The group ownership for new files and directories in a file system. + Possible values are `creator` and `parent-directory`. + If `creator` is selected, the owning group of new files and directories + is the primary group of the user who creates them. + If `parent-directory` is selected, the owning group is the parent + directory group. + Note: Existing files and directories are unaffected by this change. + If not specified, defaults to `creator`. + type: string + hard_limit_enabled: + description: | + If set to `true`, the file system's size, as defined by `provisioned`, + is used as a hard limit quota. If not specified, defaults to `false`. + type: boolean + http: + description: HTTP configuration. + title: Http + allOf: + - $ref: '#/components/schemas/_http' + multi_protocol: + description: Multi-protocol configuration. + title: MultiProtocolPost + allOf: + - $ref: '#/components/schemas/_multiProtocolPost' + nfs: + description: NFS configuration. + title: Nfs + allOf: + - $ref: '#/components/schemas/_nfs' + node_group: + description: | + The node group's nodes are where the file system's files are stored. + Used only on hardware platforms supporting nodes. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + provisioned: + description: | + The provisioned size of the file system, displayed in bytes. If set to an + empty string (`""`), the file system is unlimited in size. + If not specified, defaults to unlimited. + type: integer + format: int64 + qos_policy: + description: | + The QoS policy for the File System defines the performance controls + that can be applied to the aggregate performance of all the clients + accessing the file system. + If no policy is set here, no explicit performance controls are applied + to the file system beyond the system's default fairness. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + requested_promotion_state: + description: | + Possible values are `promoted` and `demoted`. + The `demoted` state is used for replication targets and is only allowed to be set + if the file system is in a replica-link relationship. The additional + query param `discard-non-snapshotted-data` must be set to `true` + when demoting a file system. The default for new file systems is + `promoted`. + type: string + readOnly: true + smb: + description: SMB configuration. + title: SmbPost + allOf: + - $ref: '#/components/schemas/_smbPost' + snapshot_directory_enabled: + description: | + If set to `true`, a hidden .snapshot directory will be present in each + directory of the file system when it is mounted. + The .snapshot directory allows clients read access to the contents of + the snapshots that have been taken of a directory. + If set to `false`, the .snapshot directory will not be present in any + directories within a mounted file system. If not specified, defaults to `true`. + type: boolean + source: + description: | + The source snapshot whose data is copied to the file system specified. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + workload: + $ref: '#/components/schemas/_workloadConfigurationReferencePost' + writable: + description: | + Whether the file system is writable or not. If `false`, this overrides + any protocol or file permission settings and prevents changes. If `true`, then + the protocol and file permission settings are evaluated. + If not specified, defaults to `true`. Modifiable. + type: boolean + FileSystemPatch: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + created: + description: Creation timestamp of the file system. + type: integer + format: int64 + readOnly: true + default_group_quota: + description: The default space quota for a group writing to this file system. + type: integer + format: int64 + default_user_quota: + description: The default space quota for a user writing to this file system. + type: integer + format: int64 + destroyed: + description: | + Returns a value of `true` if the file system has been destroyed and is pending eradication. + The file system cannot be modified while it is in the destroyed state. + The `time_remaining` value displays the amount of time left until the destroyed + file system is permanently eradicated. Once eradication has begun, the file system can no + longer be recovered. Before the `time_remaining` period has elapsed, + the destroyed file system can be recovered through the PATCH method + by setting `destroyed=false`. + type: boolean + fast_remove_directory_enabled: + description: | + If set to `true`, the file system, when mounted, will contain a + directory that can be used for fast removal of other directories. + Directories can be moved into the fast remove directory in order + to have them deleted, and their space freed, more quickly than a + normal removal operation. + type: boolean + group_ownership: + description: | + The group ownership for new files and directories in a file system. + Possible values are `creator` and `parent-directory`. + If `creator` is selected, the owning group of new files and directories + is the primary group of the user who creates them. + If `parent-directory` is selected, the owning group is the parent + directory group. + Note: Existing files and directories are unaffected by this change. + type: string + hard_limit_enabled: + description: | + If set to `true`, the file system's size, as defined by `provisioned`, + is used as a hard limit quota. + type: boolean + http: + description: HTTP configuration. + title: Http + allOf: + - $ref: '#/components/schemas/_http' + multi_protocol: + description: Multi-protocol configuration. + title: MultiProtocol + allOf: + - $ref: '#/components/schemas/_multiProtocol' + nfs: + description: NFS configuration. + title: NfsPatch + allOf: + - $ref: '#/components/schemas/_nfsPatch' + promotion_status: + description: | + Possible values are `promoted` and `demoted`. + The current status of the file system with respect to replication. Changes via + `requested_promotion_state`. The default for new file systems is + `promoted`. + type: string + readOnly: true + provisioned: + description: | + The provisioned size of the file system, displayed in bytes. If set to an + empty string (`""`), the file system is unlimited in size. + type: integer + format: int64 + example: 1048576 + qos_policy: + description: | + The QoS policy for the File System defines the performance controls + that can be applied to the aggregate performance of all the clients + accessing the file system. + If no policy is configured for a file system, then no performance + controls are applied to it. + Use "" to clear an attached policy. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + requested_promotion_state: + description: | + Possible values are `promoted` and `demoted`. + The `demoted` state is used for replication targets and is only allowed to be set + if the file system is in a replica-link relationship. The additional + query param `discard-non-snapshotted-data` must be set to `true` + when demoting a file system. The default for new file systems is + `promoted`. + type: string + smb: + description: SMB configuration. + title: Smb + allOf: + - $ref: '#/components/schemas/_smb' + snapshot_directory_enabled: + description: | + If set to `true`, a hidden .snapshot directory will be present in each + directory of the file system when it is mounted. + The .snapshot directory allows clients read access to the contents of + the snapshots that have been taken of a directory. + If set to `false`, the .snapshot directory will not be present in any + directories within a mounted file system. + type: boolean + source: + description: A reference to the source file system. + title: FixedLocationReference + allOf: + - $ref: '#/components/schemas/_fixedLocationReference' + storage_class: + $ref: '#/components/schemas/StorageClassInfo' + time_remaining: + description: | + Time in milliseconds before the file system is eradicated. + `null` if not destroyed. + type: integer + format: int64 + readOnly: true + workload: + $ref: '#/components/schemas/_workloadConfigurationReferencePatch' + writable: + description: | + Whether the file system is writable or not. If `false`, this overrides + any protocol or file permission settings and prevents changes. If `true`, then + the protocol and file permission settings are evaluated. + If not specified, defaults to `true`. Modifiable. + type: boolean + FileSystemGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemResponse' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + total: + $ref: '#/components/schemas/FileSystem' + FileSystemResponse: + type: object + properties: + items: + description: A list of file system objects. + type: array + items: + $ref: '#/components/schemas/FileSystem' + FileSystemGroupsPerformanceGetResponse: + type: object + properties: + items: + description: A list of file system group performance objects. + type: array + items: + $ref: '#/components/schemas/FileSystemGroupPerformance' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/FileSystemGroupPerformance' + FileSystemPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of file system performance objects. + type: array + items: + $ref: '#/components/schemas/FileSystemPerformance' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/FileSystemPerformance' + FileSystemUsersPerformanceGetResponse: + type: object + properties: + items: + description: A list of file system user performance objects. + type: array + items: + $ref: '#/components/schemas/FileSystemUserPerformance' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/FileSystemUserPerformance' + WormDataPoliciesMembersGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/WormDataPoliciesMembersResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileSystemExportPost: + type: object + properties: + 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: Reference to the server the export will be visible on. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + share_policy: + description: Reference to the SMB share policy (only used for SMB). + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + FileSystemExportPatch: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_fileSystemExportBase' + FileSystemExportGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemExportResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileSystemExportResponse: + type: object + properties: + items: + description: A list of file system export objects. + type: array + items: + $ref: '#/components/schemas/FileSystemExport' + FileSystemReplicaLink: + allOf: + - $ref: '#/components/schemas/_replicaLinkBuiltIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + link_type: + description: | + Type of the replica link. + Values include `full-replica`, and `partial-replica`. + type: string + local_file_system: + description: Reference to a local file system. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policies: + type: array + items: + description: Reference to a policy that is driving replication. + title: LocationReference + allOf: + - $ref: '#/components/schemas/_locationReference' + recovery_point: + description: | + Time when the last replicated snapshot was created, in milliseconds + since UNIX epoch. I.e. the recovery point if the file system is promoted. + type: integer + format: int64 + readOnly: true + example: 1565034592494 + remote: + description: Reference to a remote array. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + remote_file_system: + description: Reference to a remote file system. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + status: + description: | + Status of the replica link. + Values include `replicating`, `idle`, and `unhealthy`. + type: string + readOnly: true + FileSystemReplicaLinkGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemReplicaLinkResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileSystemReplicaLinkResponse: + type: object + properties: + items: + description: A list of file system replica link objects. + type: array + items: + $ref: '#/components/schemas/FileSystemReplicaLink' + PolicyMemberWithRemoteGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyMemberWithRemoteResponse' + - $ref: '#/components/schemas/_errorContextResponse' + PolicyMemberWithRemoteResponse: + allOf: + - $ref: '#/components/schemas/_context' + - type: object + properties: + items: + description: A list of members for policies. + type: array + items: + $ref: '#/components/schemas/PolicyMemberWithRemote' + FileSystemSnapshotGetTransferResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemSnapshotTransferResponse' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + total: + description: | + If `total_only` query param is `true`, then it 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. + title: FileSystemSnapshotTransfer + allOf: + - $ref: '#/components/schemas/FileSystemSnapshotTransfer' + FileSystemSnapshotPost: + type: object + properties: + suffix: + description: "The suffix of the snapshot, e.g., `snap1`." + type: string + FileSystemSnapshot: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/_context' + - type: object + properties: + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + destroyed: + description: | + Is the file system snapshot destroyed? If not specified, defaults to + `false`. + type: boolean + owner: + description: | + A reference to the file system that owns this snapshot. + If the owner is destroyed, this will be destroyed. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + owner_destroyed: + description: Is the owning file system destroyed? + type: boolean + readOnly: true + policies: + description: An array of references to the associated policies. + readOnly: true + type: array + items: + $ref: '#/components/schemas/_fixedLocationReference' + policy: + description: | + A reference to the associated policy that drives the behavior of the + snapshot. + title: FixedLocationReference + allOf: + - $ref: '#/components/schemas/_fixedLocationReference' + source: + description: | + A reference to the file system that was the source of the data in + this snapshot. Normally this is the same as the owner, but if + the snapshot is replicated, the source is the original file system. + title: FixedLocationReference + allOf: + - $ref: '#/components/schemas/_fixedLocationReference' + suffix: + description: "The suffix of the snapshot, e.g., `snap1`." + type: string + readOnly: true + example: snap1 + time_remaining: + description: | + Time in milliseconds before the file system snapshot is eradicated. + `null` if not destroyed. + type: integer + format: int64 + readOnly: true + FileSystemSnapshotGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemSnapshotResponse' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + total: + description: | + If `total_only` query param is `true`, then it 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. + title: FileSystemSnapshot + allOf: + - $ref: '#/components/schemas/FileSystemSnapshot' + FileSystemSnapshotResponse: + type: object + properties: + items: + description: A list of file system snapshot objects. + type: array + items: + $ref: '#/components/schemas/FileSystemSnapshot' + PolicyFileSystemSnapshotGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyFileSystemSnapshotResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileLockGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileLockResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileSystemClientsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemClientsResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileLockNlmReclamationResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/FileSystemLockNlmReclamation' + FileSessionGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSessionResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileSystemSpaceStorageClassGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of file system storage class space objects. + type: array + items: + $ref: '#/components/schemas/FileSystemStorageClassSpace' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/FileSystemStorageClassSpace' + FileSystemOpenFilesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemOpenFilesResponse' + 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' + Hardware: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + data_mac: + description: | + Ethernet (data) MAC address + type: string + readOnly: true + example: fa:16:3e:a1:c6:ce + details: + description: | + Details about the status of the component if not healthy. + type: string + readOnly: true + example: Temperature too high + 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 + readOnly: true + example: 1 + management_mac: + description: | + Hardware component (burned-in) MAC address + type: string + readOnly: true + example: 24:a9:37:ca:a0:d0 + model: + description: Model number of the hardware component. + type: string + readOnly: true + example: FB-8TB + part_number: + description: | + Part number of the hardware component. + type: string + readOnly: true + example: 83-0139-01 + sensor_readings: + type: array + readOnly: true + items: + $ref: '#/components/schemas/HardwareTemperatures' + serial: + description: Serial number of the hardware component. + type: string + readOnly: true + example: S16445515B09553 + slot: + description: | + Slot number occupied by the PCI Express card that hosts the component. + type: integer + format: int32 + readOnly: true + example: 16 + speed: + description: The maximum speed (in b/s) at which the component is capable of operating. + type: integer + format: int64 + readOnly: true + example: 10000000000 + status: + description: | + Component status. + Valid values are `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: | + Type of hardware component. + Valid values are `bay`, `ch`, `eth`, `fan`, `fb`, `fm`, `pwr`, and `xfm`. + type: string + readOnly: true + example: ch + HardwareGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/HardwareResponse' + HardwareResponse: + type: object + properties: + items: + description: A list of hardware component objects. + type: array + items: + $ref: '#/components/schemas/Hardware' + HardwareConnector: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + connector_type: + description: | + Form-factor of the interface. + Valid values include QSFP, QSFP+, QSFP28, QSFP56, QSFP-DD, RJ-45, and -. + type: string + readOnly: true + example: QSFP + lane_speed: + description: | + Configured speed of each lane in the connector in bits-per-second. + type: integer + format: int64 + example: 10000000000 + lanes_per_port: + description: Configured number of lanes comprising each port in the connector. + type: integer + format: int64 + example: 4 + port_count: + description: | + Configured number of ports in the connector (1/2/4 for QSFP). + type: integer + format: int64 + example: 1 + port_speed: + description: Configured speed of each port in the connector in bits-per-second. + type: integer + format: int64 + example: 40000000000 + transceiver_type: + description: | + Details about the transceiver which is plugged into the connector port. + Transceiver type will be read-only for pureuser. If nothing is plugged + into QSFP port, value will be `Unused` and type cannot be auto-detected, + and internal user has not specified a type - value will be `Unknown`. + If transceiver is plugged in, and type is auto-detected, and/or type + has been explicitly set by internal user - that value will be shown. + Transceiver type is not applicable for RJ-45 connectors. + type: string + readOnly: true + example: 40GBASE-LR4 + HardwareConnectorGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/HardwareConnectorResponse' + HardwareConnectorResponse: + type: object + properties: + items: + description: A list of connector objects. + type: array + items: + $ref: '#/components/schemas/HardwareConnector' + HardwareConnectorPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of hardware connector performance objects. + type: array + items: + $ref: '#/components/schemas/HardwareConnectorPerformance' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no individual items will be returned. + type: array + items: + $ref: '#/components/schemas/HardwareConnectorPerformance' + KeytabPost: + type: object + properties: + source: + description: | + A reference to the Active Directory configuration for the computer account + whose keys will be rotated in order to create new keytabs for all of its + registered service principal names. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + KeytabGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/KeytabResponse' + KeytabResponse: + type: object + properties: + items: + description: A list of Kerberos keytab objects. + type: array + items: + $ref: '#/components/schemas/Keytab' + KeytabFileResponse: + description: A Kerberos keytab file. + type: string + format: binary + Keytab_file: + description: | + The keytab file to upload. + type: string + KmipServer: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + ca_certificate: + description: | + CA certificate used to validate the authenticity of the configured servers. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + ca_certificate_group: + description: | + A certificate group containing CA certificates that can be used to + validate the authenticity of the configured servers. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + uris: + description: "List of URIs for the configured KMIP servers in the format [protocol://]hostname:port." + type: array + minItems: 1 + maxItems: 30 + items: + pattern: ^(tls://)? + type: string + example: + - my1.kmipserver.com:5696 + - tls://my2.kmipserver.com:5696 + KmipServerResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/KmipServer' + LegalHold: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + description: + description: | + The description of the legal hold instance. + type: string + realms: + description: | + The realms containing this legal hold. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + LegalHoldsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LegalHoldsResponse' + LegalHoldsResponse: + type: object + properties: + items: + description: A list of legal hold instances. + type: array + items: + $ref: '#/components/schemas/LegalHold' + LegalHoldsHeldEntitiesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LegalHoldsHeldEntitiesResponse' + LegalHoldsHeldEntitiesResponse: + type: object + properties: + items: + description: A list of held entities for legal holds. + type: array + items: + $ref: '#/components/schemas/LegalHoldHeldEntity' + LifecycleRulePost: + allOf: + - $ref: '#/components/schemas/_lifecycleRuleConfigExtension' + - type: object + properties: + bucket: + description: The bucket name for lifecycle rule creation. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + keep_previous_version_for: + description: | + Time after which previous 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 + prefix: + description: | + Object key prefix identifying one or more objects in the bucket. + Can have a maximum length of 1024 characters. + type: string + rule_id: + description: | + Identifier for the rule that is unique to the bucket + that it applies to. + Can have a maximum length of 255 characters. + If not specified, an id unique to the bucket will be generated in the + format `fbRuleId` where number increments, starting at 1. + type: string + LifecycleRulePatch: + allOf: + - $ref: '#/components/schemas/_lifecycleRuleConfigExtension' + - type: object + properties: + enabled: + description: | + If set to `true`, this rule will be enabled. + type: boolean + keep_previous_version_for: + description: | + Time after which previous 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 + prefix: + description: | + Object key prefix identifying one or more objects in the bucket. + Can have a maximum length of 1024 characters. + type: string + LifecycleRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/LifecycleRuleResponse' + LifecycleRuleResponse: + type: object + properties: + items: + description: A list of lifecycle rule objects. + type: array + items: + $ref: '#/components/schemas/LifecycleRule' + LinkAggregationGroup: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: | + Configuration information for a combination of physical ports grouped + together into an aggregated-port. + type: object + properties: + lag_speed: + description: | + Combined speed of all ports in the LAG in bits-per-second. + type: integer + format: int64 + readOnly: true + example: 260000000000 + mac_address: + description: Unique MAC address assigned to the LAG. + type: string + pattern: "^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$" + readOnly: true + example: 24:a9:37:11:f5:21 + port_speed: + description: Configured speed of each port in the LAG in bits-per-second. + type: integer + format: int64 + readOnly: true + example: 10000000000 + ports: + description: Ports associated with the LAG. + type: array + items: + $ref: '#/components/schemas/_reference' + status: + description: | + Health status of the LAG. + Valid values are `critical`, `healthy`, `identifying`, `unclaimed`, + `unhealthy`, `unrecognized`, and `unused`. + type: string + readOnly: true + example: healthy + LinkAggregationGroupPatch: + type: object + properties: + add_ports: + type: array + items: + $ref: '#/components/schemas/_reference' + ports: + type: array + items: + $ref: '#/components/schemas/_reference' + remove_ports: + type: array + items: + $ref: '#/components/schemas/_reference' + LinkAggregationGroupGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LinkAggregationGroupResponse' + LinkAggregationGroupResponse: + type: object + properties: + items: + description: A list of lag objects. + type: array + items: + $ref: '#/components/schemas/LinkAggregationGroup' + LogsAsync: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + available_files: + description: | + All of the available files ready for download. + type: array + readOnly: true + items: + $ref: '#/components/schemas/FileInfo' + end_time: + description: | + When the time window ends (in milliseconds since epoch). + start_time and end_time determine the number of hours for which the logs are prepared for. + At most 6 hours of logs can be prepared in one request. + start_time and end_time are truncated to hour boundaries. + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + hardware_components: + description: | + All of the hardware components for which logs are being processed. + type: array + items: + $ref: '#/components/schemas/_reference' + last_request_time: + description: | + The last time log preparation was requested (in milliseconds since epoch). + type: integer + format: int64 + minimum: 0 + readOnly: true + example: 1514764800000 + processing: + description: | + Returns a value of `true` if the logs are being prepared. + type: boolean + readOnly: true + progress: + description: | + A representation of log preparation progress. Ranges from 0 to 1.0. + type: number + format: float + readOnly: true + example: 0.99 + start_time: + description: | + When the time window starts (in milliseconds since epoch). + start_time and end_time determine the number of hours for which the logs are prepared for. + At most 6 hours of logs can be prepared in one request. + start_time and end_time are truncated to hour boundaries. + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + LogsAsyncGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LogsAsyncResponse' + LogsAsyncResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/LogsAsync' + LogTargetsFileSystemsPost: + allOf: + - $ref: '#/components/schemas/LogTargetsFileSystems' + LogTargetsFileSystems: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + file_system: + description: The target filesystem where audit logs will be stored. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + keep_for: + description: | + Specifies the period that audit logs are retained before they are deleted, + in milliseconds. + Default value is `null` which means time 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`. + At least one of the `keep_for` or `keep_size` parameters is required, + and they can be set together. + type: integer + format: int64 + minimum: 1000000 + example: 1000000 + LogTargetsFileSystemsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LogTargetsFileSystemsResponse' + LogTargetsFileSystemsResponse: + type: object + properties: + items: + description: A list of log target objects. + type: array + items: + $ref: '#/components/schemas/LogTargetsFileSystems' + LogTargetsObjectStorePost: + allOf: + - $ref: '#/components/schemas/LogTargetsObjectStore' + LogTargetsObjectStore: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + bucket: + description: | + Reference to the bucket where audit logs will be stored. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + log_name_prefix: + description: | + The prefix of the audit log object. + title: AuditLogNamePrefix + allOf: + - $ref: '#/components/schemas/_auditLogNamePrefix' + log_rotate: + description: | + The threshold after which the audit log object will be rotated. + title: AuditLogRotate + allOf: + - $ref: '#/components/schemas/_auditLogRotate' + LogTargetsObjectStoreGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LogTargetsObjectStoreResponse' + - $ref: '#/components/schemas/_errorContextResponse' + LogTargetsObjectStoreResponse: + type: object + properties: + items: + description: A list of log target objects. + type: array + items: + $ref: '#/components/schemas/LogTargetsObjectStoreWithContext' + MaintenanceWindowPost: + type: object + properties: + timeout: + description: | + Duration of a maintenance window measured in milliseconds. + The `names` and `timeout` parameters must be set together, and the `names` parameter + must be set to `array`. + type: integer + format: int32 + example: 14400000 + MaintenanceWindowsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/MaintenanceWindowsResponse' + MaintenanceWindowsResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/MaintenanceWindow' + ManagementAccessPolicyPost: + allOf: +# Management access policies can be renamed, but POST doesn't accept a name in the +# body, so we need to use the name-is-read-only version instead + - $ref: '#/components/schemas/PolicyBase' + - 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. + If not specified, defaults to `all-permissions`. + type: string + rules: + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/ManagementAccessPolicyRuleInPolicy' + description: | + All of the rules that are part of this policy. The order is the evaluation order. + ManagementAccessPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - 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. + If not specified, defaults to `all-permissions`. + type: string + rules: + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/ManagementAccessPolicyRuleInPolicy' + description: | + All of the rules that are part of this policy. The order is the evaluation order. + ManagementAccessPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ManagementAccessPoliciesResponse' + ManagementAccessPoliciesResponse: + type: object + properties: + items: + description: A list of management access policy configuration objects. + type: array + items: + $ref: '#/components/schemas/ManagementAccessPolicy' + ManagementAuthenticationPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + ssh: + description: | + The management authentication config for SSH logins. This controls what authentication + factors admins need to present when logging in via SSH. + title: ManagementAuthenticationPolicyConfig + allOf: + - $ref: '#/components/schemas/ManagementAuthenticationPolicyConfig' + ManagementAuthenticationPolicy: + allOf: + - $ref: '#/components/schemas/ManagementAuthenticationPolicyPost' + - $ref: '#/components/schemas/PolicyBaseContext' + ManagementAuthenticationPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ManagementAuthenticationPoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + ManagementAuthenticationPoliciesResponse: + type: object + properties: + items: + description: A list of management authentication policy objects. + type: array + items: + $ref: '#/components/schemas/ManagementAuthenticationPolicy' + NetworkAccessPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - type: object + properties: + rules: + description: | + All of the rules that are part of this policy. The order is the + evaluation order. + If a client does not match any rule in the policy for the interface that + they are attempting to access, the default is to deny access. + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/NetworkAccessPolicyRuleInPolicy' + NetworkAccessPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkAccessPolicyResponse' + NetworkAccessPolicyResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/NetworkAccessPolicy' + NetworkAccessPolicyRulePost: + allOf: + - $ref: '#/components/schemas/NetworkAccessPolicyRulePostBase' + - $ref: '#/components/schemas/_policyRuleIndex' + NetworkAccessPolicyRule: + allOf: + - $ref: '#/components/schemas/NetworkAccessPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndex' + NetworkAccessPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkAccessPolicyRuleResponse' + NetworkAccessPolicyRuleResponse: + type: object + properties: + items: + description: | + Displays a list of all items after filtering. + type: array + items: + $ref: '#/components/schemas/NetworkAccessPolicyRule' + NetworkInterface: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + address: + description: | + The IPv4 or IPv6 address to be associated with the specified network + interface. + type: string + attached_servers: + description: | + List of servers that are using this interface for data ingress. + When services include 'data' defaults to [_array_server], otherwise to []. + type: array + items: + $ref: '#/components/schemas/_reference' + enabled: + description: | + Indicates if the specified network interface is enabled (`true`) or + disabled (`false`). If not specified, defaults to `true`. + type: boolean + readOnly: true + gateway: + description: Derived from `subnet.gateway`. + type: string + readOnly: true + mtu: + description: Derived from `subnet.mtu`. + type: integer + format: int32 + readOnly: true + netmask: + description: Derived from `subnet.prefix`. + type: string + readOnly: true + realms: + description: | + The realms containing this network interface. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + services: + description: Services and protocols that are enabled on the interface. + type: array + items: + type: string + description: | + Valid values are `data`, `egress-only`, `management`, `replication`, and `support`. + subnet: + type: object + allOf: + - $ref: '#/components/schemas/_fixedReference' + - type: object + readOnly: true + type: + description: | + The only valid value is `vip`. + type: string + vlan: + description: Derived from `subnet.vlan`. + type: integer + format: int32 + readOnly: true + NetworkInterfacePatch: + type: object + properties: + address: + description: | + The IPv4 or IPv6 address to be associated with the specified network + interface. + type: string + attached_servers: + description: | + 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. + If services include 'data' and attached_servers was [] then attached_servers defaults to [_array_server]. + type: array + items: + $ref: '#/components/schemas/_referenceWithoutType' + services: + description: Services and protocols that are enabled on the interface. + type: array + items: + type: string + description: | + Valid values are `data`, `egress-only`, `management`, `replication`, and `support`. + NetworkInterfaceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkInterfaceResponse' + NetworkInterfaceResponse: + type: object + properties: + items: + description: A list of network interface objects. + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + NetworkInterfacePingGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkInterfacePingResponse' + NetworkInterfaceTraceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkInterfaceTraceResponse' + NetworkInterfacesConnectorsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkInterfacesConnectorsResponse' + NetworkInterfacesConnectorsResponse: + type: object + properties: + items: + description: A list of network connector objects. + type: array + items: + $ref: '#/components/schemas/HardwareConnector' + NetworkInterfacesConnectorsPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of network connector performance objects. + type: array + items: + $ref: '#/components/schemas/NetworkInterfacesConnectorsPerformance' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no individual items will be returned. + type: array + items: + $ref: '#/components/schemas/NetworkInterfacesConnectorsPerformance' + NetworkInterfacesConnectorsSettingsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of global network settings for network connectors. + type: array + items: + $ref: '#/components/schemas/NetworkInterfacesConnectorsSetting' + NetworkConnectionStatisticsGetResponse: + allOf: + - $ref: '#/components/schemas/NetworkConnectionStatisticsResponse' + NetworkInterfaceNeighborGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkInterfaceNeighborResponse' + NfsExportPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + rules: + description: | + All of the rules that are part of this policy. The order is the evaluation order. + type: array + items: + $ref: '#/components/schemas/NfsExportPolicyRuleInPolicy' + NfsExportPolicyPatch: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - type: object + properties: + rules: + description: | + All of the rules that are part of this policy. The order is the evaluation order. + type: array + items: + $ref: '#/components/schemas/NfsExportPolicyPatchRuleInPolicy' + NfsExportPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NfsExportPolicyResponse' + - $ref: '#/components/schemas/_errorContextResponse' + NfsExportPolicyResponse: + type: object + properties: + items: + description: A list of NFS export policy objects. + type: array + items: + $ref: '#/components/schemas/NfsExportPolicy' + NfsExportPolicyRule: + allOf: + - $ref: '#/components/schemas/NfsExportPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndex' + - $ref: '#/components/schemas/_context' + NfsExportPolicyRulePatch: + allOf: + - $ref: '#/components/schemas/NfsExportPolicyRuleBasePatchRequest' + - $ref: '#/components/schemas/_policyRuleIndex' + NfsExportPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NfsExportPolicyRuleResponse' + - $ref: '#/components/schemas/_errorContextResponse' + NfsExportPolicyRuleResponse: + type: object + properties: + items: + description: | + Displays a list of all items after filtering. + type: array + items: + $ref: '#/components/schemas/NfsExportPolicyRule' + Node: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + capacity: + description: | + The available capacity of the node in bytes. + type: integer + format: int64 + readOnly: true + chassis_serial_number: + description: | + The serial number of the chassis the node is in, if applicable. + type: string + readOnly: true + data_addresses: + description: | + List of data IP addresses of the node. + type: array + readOnly: true + items: + type: string + details: + description: | + The description of the status of the node if not healthy. + type: string + readOnly: true + management_address: + description: | + The control IP address of the node. A connection will be made + to this address to get info on the node such as the data addresses. + If a connection cannot be made to the given management address, + both the POST and PATCH request modifying this field will fail. + type: string + raw_capacity: + description: | + The raw capacity of the node in bytes. + type: integer + format: int64 + readOnly: true + serial_number: + description: | + The serial number of the node. + If the given serial number does not match the serial number of the node, + both the POST and PATCH request modifying this field will fail. + type: string + status: + description: | + The status of the node. + Values include `critical`, `healthy`, and `unhealthy`. + type: string + readOnly: true + unique: + description: | + The unique physical space occupied by customer data in bytes. + type: integer + format: int64 + readOnly: true + NodeGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NodeResponse' + - type: object + properties: + total: + $ref: '#/components/schemas/Node' + NodeResponse: + type: object + properties: + items: + description: A list of node objects. + type: array + items: + $ref: '#/components/schemas/Node' + NodeGroupPatch: + allOf: + - $ref: '#/components/schemas/_referenceNameOnly' + NodeGroupGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NodeGroupResponse' + NodeGroupResponse: + type: object + properties: + items: + description: A list of node group objects. + type: array + items: + $ref: '#/components/schemas/NodeGroup' + NodeGroupNodeGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NodeGroupNodeResponse' + NodeGroupNodeResponse: + type: object + properties: + items: + description: | + A list of node and node group relationships. + type: array + items: + $ref: '#/components/schemas/Member' + NodeGroupUseGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of node group use objects. + type: array + items: + $ref: '#/components/schemas/NodeGroupUse' + ObjectStoreAccessKeyPost: + type: object + properties: + secret_access_key: + description: | + The secret access key to import from another FlashBlade. + To import a set of credentials, this field must be specified + with the `names` query parameter where the `names` includes + prefix of the realm where the user lives. If both of these are not + specified, the system will generate a new set of credentials. + type: string + user: + type: object + allOf: + - $ref: '#/components/schemas/_reference' + - description: Reference of the associated user. + type: object + ObjectStoreAccessKey: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + access_key_id: + description: | + The access key ID which can be used directly to + authorize S3 operations. + type: string + readOnly: true + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + enabled: + description: | + Is the access key enabled? If not specified, defaults to `false`. + type: boolean + secret_access_key: + description: | + The secret access key, only populated on creation if it is not + imported from another FlashBlade. + type: string + readOnly: true + user: + description: Reference of the associated user. + readOnly: true + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + 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' + ObjectStoreAccessPolicyPost: + allOf: + - $ref: '#/components/schemas/ObjectStoreAccessPolicyPatch' + - type: object + properties: + description: + description: | + A description of the policy, optionally specified when the policy is + created. Cannot be modified for an existing policy. + type: string + ObjectStoreAccessPolicyPatch: + type: object + properties: + rules: + type: array + items: + $ref: '#/components/schemas/PolicyRuleObjectAccessBulkManage' + ObjectStoreAccessPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreAccessPolicyResponse' + ObjectStoreAccessPolicyResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ObjectStoreAccessPolicy' + PolicyRuleObjectAccessPost: + type: object + properties: + actions: + description: | + The list of actions granted by this rule. Each included action may + restrict other properties of the rule. + Supported actions are returned by the + `/object-store-access-policy-actions` endpoint. + type: array + items: + type: string + example: + - s3:CreateBucket + - s3:PutObject + conditions: + description: | + Conditions used to limit the scope which this rule applies to. + title: PolicyRuleObjectAccessCondition + allOf: + - $ref: '#/components/schemas/_policyRuleObjectAccessCondition' + 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 + example: allow + 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* + ObjectStoreAccessPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreAccessPolicyRuleResponse' + ObjectStoreAccessPolicyRuleResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/PolicyRuleObjectAccess' + ObjectStoreAccessPolicyActionGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreAccessPolicyActionResponse' + ObjectStoreAccountPost: + type: object + properties: + account_exports: + description: | + A list of exports to be created for the account. + + If ommited or set to `null`, the default server for object store will be used. + Use `[]` to create an account without any export. + type: array + items: + title: ServerForAccountExport + allOf: + - $ref: '#/components/schemas/_serverForAccountExport' + bucket_defaults: + description: | + Default settings to be applied to newly created buckets associated with + this account. Values here will be used in bucket creation requests which + do not specify their own values for corresponding fields. + title: BucketDefaults + allOf: + - $ref: '#/components/schemas/_bucketDefaults' + hard_limit_enabled: + description: | + If set to `true`, the account's size, as defined by `quota_limit`, + is used as a hard limit quota. + If set to `false`, a hard limit quota will not be applied to the + account, but soft quota alerts will still be sent if the account has + a value set for `quota_limit`. + If not specified, defaults to `false`. + type: boolean + quota_limit: + description: | + The effective quota limit to be applied against the size of the account, displayed in bytes. + If set to an empty string (`""`), the account is unlimited in size. If not specified, + defaults to unlimited. + type: string + ObjectStoreAccountPatch: + type: object + properties: + bucket_defaults: + description: | + Default settings to be applied to newly created buckets associated with + this account. Values here will be used in bucket creation requests which + do not specify their own values for corresponding fields. + title: BucketDefaults + allOf: + - $ref: '#/components/schemas/_bucketDefaults' + hard_limit_enabled: + description: | + If set to `true`, the account's size, as defined by `quota_limit`, + is used as a hard limit quota. + If set to `false`, a hard limit quota will not be applied to the + account, but soft quota alerts will still be sent if the account has + a value set for `quota_limit`. + type: boolean + public_access_config: + $ref: '#/components/schemas/_publicAccessConfig' + quota_limit: + description: | + The effective quota limit to be applied against the size of the account, displayed in bytes. + If set to an empty string (`""`), the account is unlimited in size. + type: string + 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. + title: ObjectStoreAccount + allOf: + - $ref: '#/components/schemas/ObjectStoreAccount' + ObjectStoreAccountResponse: + type: object + properties: + items: + description: A list of object store account objects. + type: array + items: + $ref: '#/components/schemas/ObjectStoreAccount' + ObjectStoreAccountExportPost: + type: object + required: + - server + properties: + export_enabled: + description: | + If set to `true`, the account export is enabled. + If not specified, defaults to `true`. + type: boolean + example: true + server: + description: Reference to the server the export will be visible on. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + ObjectStoreAccountExportPatch: + type: object + properties: + export_enabled: + description: | + If set to `true`, the account export is enabled. + If not specified, defaults to `true`. + type: boolean + example: true + policy: + description: Reference to the s3 export policy that is used for the export. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + ObjectStoreAccountExportGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ObjectStoreAccountExportResponse' + - $ref: '#/components/schemas/_errorContextResponse' + ObjectStoreAccountExportResponse: + type: object + properties: + items: + description: A list of object store account export objects. + type: array + items: + $ref: '#/components/schemas/ObjectStoreAccountExport' + ObjectStoreRemoteCredentialsPost: + type: object + properties: + access_key_id: + description: | + Access Key ID to be used when connecting to a remote object store. + type: string + example: PSFBIKZFCAAAKOEJ + secret_access_key: + description: | + Secret Access Key to be used when connecting to a remote object store. + type: string + example: 0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD + ObjectStoreRemoteCredentials: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/_context' + - type: object + properties: + access_key_id: + description: | + Access Key ID to be used when connecting to a remote object store. + type: string + example: PSFBIKZFCAAAKOEJ + realms: + description: | + The realms containing this credentials for remote. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + remote: + description: | + Reference to the associated remote, which can either be a `target` or remote `array`. + If it is an `array`, then the `resource-type` field will not be populated. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + secret_access_key: + description: | + Secret Access Key to be used when connecting to a remote object store. + type: string + example: 0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD + ObjectStoreRemoteCredentialGetResp: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreRemoteCredentialsResp' + ObjectStoreRemoteCredentialsResp: + type: object + properties: + items: + description: A list of object store remote credentials. + type: array + items: + $ref: '#/components/schemas/ObjectStoreRemoteCredentials' + ObjectStoreRolePost: + type: object + properties: + max_session_duration: + description: | + Maximum session duration in milliseconds. + If not provided when creating the role, defaults to 1h, minimum is 1h, maximum is 12h. + type: integer + ObjectStoreRole: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + account: + description: Reference of the associated account. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + max_session_duration: + description: | + The maximum session duration for the role in milliseconds + type: integer + prn: + description: Pure Resource Name of the role + type: string + readOnly: true + example: prn::iam:array-id/local:obj-account-id/123456789101112:role/myrole + trusted_entities: + description: List of trusted entities + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + ObjectStoreRoleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreRoleResponse' + ObjectStoreRoleResponse: + type: object + properties: + items: + description: A list of object store roles. + type: array + items: + $ref: '#/components/schemas/ObjectStoreRole' + ObjectStoreTrustPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreTrustPolicyResponse' + ObjectStoreTrustPolicyIam: + description: Trust policy document in the AWS IAM format. + type: string + example: |- + { + "Version": "2012-10-17", + "Statement": [{ + "Action": "sts:AssumeRoleWithSAML", + "Effect": "Allow", + "Principal": { + "Federated": "arn:aws:iam:::saml-provider/example" + }, + "Condition": { + "StringEquals": { + "saml:aud": "engineers" + } + } + }] + } + ObjectStoreTrustPolicyResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ObjectStoreTrustPolicy' + TrustPolicyRulePost: + type: object + properties: + actions: + description: | + The list of role-assumption actions granted by this rule to the respective role. + Currently we support `sts:AssumeRoleWithSAML` and `sts:AssumeRoleWithWebIdentity` actions. + type: array + items: + type: string + example: + - sts:AssumeRoleWithSAML + conditions: + description: | + Conditions used to limit the scope which this rule applies to. + type: array + items: + $ref: '#/components/schemas/_trustPolicyRuleCondition' + 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. + Valid values include `allow`. + type: string + readOnly: true + example: allow + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + principals: + description: List of Identity Providers + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + ObjectStoreTrustPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreTrustPolicyRuleResponse' + ObjectStoreTrustPolicyRuleResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/TrustPolicyRuleWithContext' + 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' + ObjectStoreVirtualHost: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + description: | + Hostname configuration for virtual hosted-style S3 requests. + properties: + attached_servers: + description: | + A list of servers which are allowed to use this virtual host. + If it is `null` or not specified and a default object store + server is configured, it will be automatically attached. If + set to `[]`, no servers are attached. + type: array + items: + $ref: '#/components/schemas/_reference' + hostname: + description: | + A hostname by which the array can be addressed for + virtual hosted-style S3 requests. A hostname cannot + exceed 255 characters in length, it cannot be an IP + address, and supersets or subsets of existing hostnames + with the same root are not allowed. + type: string + example: s3.myarray.com + realms: + description: | + A list of realms containing this virtual host. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + ObjectStoreVirtualHostPatch: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + add_attached_servers: + description: | + A list of new servers which are allowed to use this virtual host. + type: array + items: + $ref: '#/components/schemas/_reference' + attached_servers: + description: | + A list of servers which are allowed to use this virtual host. + If it is `null` or not specified and a default object store + server is configured, it will be automatically attached. If + set to `[]`, no servers are attached. + type: array + items: + $ref: '#/components/schemas/_reference' + hostname: + description: | + A hostname by which the array can be addressed for + virtual hosted-style S3 requests. A hostname cannot + exceed 255 characters in length, it cannot be an IP + address, and supersets or subsets of existing hostnames + with the same root are not allowed. + type: string + example: s3.myarray.com + remove_attached_servers: + description: | + A list of servers which will no longer be allowed to use this virtual host. + type: array + items: + $ref: '#/components/schemas/_reference' + 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' + PasswordPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - type: object + properties: + enforce_dictionary_check: + description: | + If `true`, test password against dictionary of known leaked passwords. + Requires passwords longer than 6 characters. + type: boolean + example: true + enforce_username_check: + description: | + If `true`, the username cannot be a substring of the password. + Only applies to usernames of 4 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: 0 + 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: 0 + 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 1 hour precision. + 0ms value means password expiration is disabled. + Maximum age is always greater than the minimum password age. + 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. + type: integer + format: int32 + minimum: 0 + 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 with precision to 1 hour. + 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: 0 + 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 + PasswordPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PasswordPoliciesResponse' + PasswordPoliciesResponse: + 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/PasswordPolicy' + PolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + retention_lock: + description: | + If retention lock is locked, then the the policy can not be removed + from the associated file systems and the rules may not be changed. + Valid values are `locked` and `unlocked`. + Contact Pure Technical Services to change `locked` to `unlocked`. + type: string + readOnly: true + rules: + type: array + items: + $ref: '#/components/schemas/_policy_rule' + SnapshotPolicyPatch: + allOf: + - $ref: '#/components/schemas/SnapshotWormDataPolicyBase' + - type: object + properties: + add_rules: + type: array + items: + $ref: '#/components/schemas/_policy_rule' + remove_rules: + type: array + items: + $ref: '#/components/schemas/_policy_rule' + retention_lock: + description: | + If retention lock is locked, then the the policy can not be removed + from the associated file systems and the rules may not be changed. + Valid values are `locked` and `unlocked`. + Contact Pure Technical Services to change `locked` to `unlocked`. + type: string + readOnly: true + rules: + type: array + items: + $ref: '#/components/schemas/_policy_rule' + PolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyResponse' + - $ref: '#/components/schemas/_errorContextResponse' + PolicyResponse: + type: object + properties: + items: + description: A list of policy objects. + type: array + items: + $ref: '#/components/schemas/Policy' + PolicyBaseGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyBaseResponse' + - $ref: '#/components/schemas/_errorContextResponse' + PublicKeyPost: + description: | + A public key configuration, defining a key used for cryptographic signature verification. + type: object + properties: + public_key: + description: | + The text of the public key. May be PEM-formatted or OpenSSH-formatted at the time of input. + type: string + maxLength: 5400 + PublicKeyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PublicKeyResponse' + PublicKeyResponse: + type: object + properties: + items: + description: A list of public key objects. + type: array + items: + $ref: '#/components/schemas/PublicKey' + PublicKeyUseGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PublicKeyUseResponse' + QosPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_context' + - type: object + properties: + max_total_bytes_per_sec: + description: | + The maximum allowed bytes/s totaled across all the clients. + Throttling occurs when the total bandwidth exceeds this limit. + Minimum limit is 1MB/s and maximum limit is 512GB/s. + If not specified at creation time, defaults to `null` to indicate no limit. + type: integer + format: int64 + minimum: 1048576 + maximum: 549755813888 + max_total_ops_per_sec: + description: | + The maximum allowed operations/s totaled across all the clients. + Throttling occurs when the total IOPs exceeds this limit. + Minimum limit is 100 IOPs/s and maximum limit is 100M IOPs/s. + If not specified at creation time, defaults to `null` to indicate no limit. + type: integer + format: int64 + minimum: 100 + maximum: 100000000 + QosPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/QosPoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + QosPoliciesResponse: + type: object + properties: + items: + description: A list of QoS policy objects. + type: array + items: + $ref: '#/components/schemas/QosPolicy' + GroupQuotaPost: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + required: + - quota + properties: + quota: + description: | + The space limit of the quota (in bytes) for the specified group, cannot + be `0`. If specified, this value will override the file system's default + group quota. + type: integer + format: int64 + GroupQuotaPatch: + allOf: + - $ref: '#/components/schemas/GroupQuotaPost' + GroupQuotaGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/GroupQuotaResponse' + - $ref: '#/components/schemas/_errorContextResponse' + GroupQuotaResponse: + type: object + properties: + items: + description: A list of quota objects. + type: array + items: + $ref: '#/components/schemas/GroupQuota' + QuotaSetting: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + contact: + description: | + The contact information that will be provided in any notifications + sent directly to users and groups. This can be an email, a phone + number, a name, or some other form of contact information. + type: string + example: "John Doe, john@example.com" + direct_notifications_enabled: + description: | + Are notifications regarding space usage and quotas being sent directly + to user and group emails? + type: boolean + QuotaSettingGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/QuotaSettingResponse' + QuotaSettingResponse: + type: object + properties: + items: + description: A list of quota settings objects. + type: array + items: + $ref: '#/components/schemas/QuotaSetting' + UserQuotaPost: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + required: + - quota + properties: + quota: + description: | + The limit of the quota (in bytes) for the specified user, cannot be `0`. + If specified, this value will override the file system's default user + quota. + type: integer + format: int64 + UserQuotaPatch: + allOf: + - $ref: '#/components/schemas/UserQuotaPost' + UserQuotaGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/UserQuotaResponse' + - $ref: '#/components/schemas/_errorContextResponse' + UserQuotaResponse: + type: object + properties: + items: + description: A list of quota objects. + type: array + items: + $ref: '#/components/schemas/UserQuota' + 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/PageInfo' + - $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' + RapidDataLocking: + type: object + properties: + enabled: + description: | + `True` if the Rapid Data Locking feature is enabled. + type: boolean + example: true + kmip_server: + description: | + The KMIP server configuration associated with RDL. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + RapidDataLockingResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/RapidDataLocking' + RealmPatch: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + default_inbound_tls_policy: + description: | + The default TLS policy governing inbound traffic from clients accessing the accessing the realm's + network interfaces. This TLS policy will be applied for any IP addresses within the realm that do not + have a specific policy applied to them at a more granular level. If no `default_inbound_tls_policy` + is configured, then IP addresses within the realm that do not have a specific policy + applied to them at a more granular level will not be accessible using TLS. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + 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 + by setting `destroyed=false`. + type: boolean + RealmGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/RealmResponse' + - properties: + total: + $ref: '#/components/schemas/Realm' + RealmResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Realm' + RealmDefaults: + allOf: + - $ref: '#/components/schemas/_context' + - type: object + properties: + object_store: + type: array + description: Default configurations for object store. + items: + title: ObjectStoreDefault + allOf: + - $ref: '#/components/schemas/_objectStoreDefault' + realm: + description: Realm for the defaults. + readOnly: true + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + RealmDefaultsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/RealmDefaultsResponse' + - $ref: '#/components/schemas/_errorContextResponse' + RealmDefaultsResponse: + type: object + properties: + items: + description: A list of realm default configurations. + type: array + items: + $ref: '#/components/schemas/RealmDefaults' + RealmSpaceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of realm space metrics objects. + type: array + items: + $ref: '#/components/schemas/RealmSpace' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/RealmSpace' + RealmSpaceStorageClassGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/RealmSpaceStorageClass' + description: A list of realm space metrics objects for each storage class. + total: + $ref: '#/components/schemas/RealmSpaceStorageClass' + 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' + ResiliencyGroupGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ResiliencyGroupResponse' + ResiliencyGroupMemberGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ResiliencyGroupMemberResponse' + ResourceAccessesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfoScale' + - $ref: '#/components/schemas/ResourceAccessesResponse' + ResourceAccessPost: + type: object + properties: + resource: + description: Resource to which the scope has access to. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + scope: + description: Scope which has access to the resource. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + ResourceAccessesResponse: + type: object + properties: + items: + description: A list of resource access objects. + type: array + items: + $ref: '#/components/schemas/ResourceAccess' + RoleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Role' + S3ExportPolicyPost: + type: object + properties: + enabled: + type: boolean + example: true + rules: + type: array + items: + $ref: '#/components/schemas/_s3ExportPolicyRuleInlined' + S3ExportPolicyPatch: + type: object + properties: + enabled: + type: boolean + example: true + name: + type: string + description: New name of the S3 export policy. + rules: + type: array + items: + $ref: '#/components/schemas/_s3ExportPolicyRuleInlined' + S3ExportPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/S3ExportPolicyResponse' + - $ref: '#/components/schemas/_errorContextResponse' + S3ExportPolicyResponse: + type: object + properties: + items: + description: A list of S3 export policy objects. + type: array + items: + $ref: '#/components/schemas/S3ExportPolicy' + S3ExportPolicyRulePost: + type: object + properties: + actions: + description: | + The list of actions granted by this rule. Each included action may + restrict other properties of the rule. + The only currently supported action is `pure:S3Access`. + type: array + items: + type: string + example: + - "pure:S3Access" + 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. + The currently supported effects are `allow` and `deny`. + type: string + example: allow + resources: + description: | + The list of resources from the account to which this rule applies to. + The only currently supported resource type is buckets. + type: array + items: + type: string + example: + - "*" + - mybucket + - "mybucket*" + S3ExportPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/S3ExportPolicyRuleResponse' + - $ref: '#/components/schemas/_errorContextResponse' + S3ExportPolicyRuleResponse: + type: object + description: A list of S3 export policy rule objects. + properties: + items: + type: array + items: + $ref: '#/components/schemas/S3ExportPolicyRule' + OidcSsoPost: + type: object + properties: + enabled: + description: "If set to `true`, the OIDC SSO configuration is enabled." + type: boolean + idp: + $ref: '#/components/schemas/_oidcSsoPostIdp' + prn: + description: Pure Resource Name of the identity provider + type: string + readOnly: true + example: prn::iam:array-id/local::oidc-provider/myidp + services: + description: | + Services that the OIDC SSO authentication is used for. + Valid values: `object`. + type: array + items: + type: string + OidcSsoPatch: + allOf: + - $ref: '#/components/schemas/OidcSsoPost' + - type: object + properties: + name: + description: A new name for the provider + type: string + OidcSsoGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/OidcSsoResponse' + OidcSsoResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/OidcSso' + Saml2SsoPost: + type: object + properties: + array_url: + description: The URL of the array. + type: string + example: https://myarray.mycompany.com + binding: + description: | + SAML2 binding to use for the request from Flashblade to the Identity + Provider. + Valid values: `http-redirect`, `none`. + Defaults to `http-redirect`. + type: string + enabled: + description: "If set to `true`, the SAML2 SSO configuration is enabled." + type: boolean + idp: + $ref: '#/components/schemas/_saml2SsoIdp' + prn: + description: Pure Resource Name of the identity provider + type: string + readOnly: true + example: prn::iam:array-id/local::saml-provider/myidp + services: + description: | + Services that the SAML2 SSO authentication is used for. + Valid values: `management`, `object`. + Defaults to `management`. + type: array + items: + type: string + sp: + $ref: '#/components/schemas/_saml2SsoSp' + Saml2Sso: + description: | + Configuration information for SAML2-based SSO for FlashArray. + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/Saml2SsoPost' + Saml2SsoGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/Saml2SsoResponse' + Saml2SsoResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Saml2Sso' + StorageClassTieringPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + archival_rules: + description: | + The list of archival rules for this policy. + type: array + items: + $ref: '#/components/schemas/TieringPolicyArchivalRule' + retrieval_rules: + description: | + The list of retrieval rules for this policy. + type: array + items: + $ref: '#/components/schemas/TieringPolicyRetrievalRule' + StorageClassTieringPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/StorageClassTieringPoliciesResponse' + StorageClassTieringPoliciesResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/StorageClassTieringPolicy' + description: A list of storage class tiering policy objects. + StorageClassTieringPoliciesMembersGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/StorageClassTieringPoliciesMembersResponse' + - $ref: '#/components/schemas/_errorContextResponse' + ServerPost: + type: object + properties: + dns: + description: | + The DNS config to be used by this server. + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/_reference' + ServerGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ServerResponseContext' + - $ref: '#/components/schemas/_errorContextResponse' + ServerResponse: + type: object + properties: + items: + description: A list of server objects. + type: array + items: + $ref: '#/components/schemas/Server' + SessionGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Session' + SmbClientPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - 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 + rules: + description: | + All of the rules that are part of this policy. The order is the + evaluation order. + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbClientPolicyRulePostInPolicy' + SmbClientPolicyPatch: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - 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 + rules: + description: | + All of the rules that are part of this policy. The order is the + evaluation order. + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbClientPolicyRuleInPolicy' + SmbClientPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SmbClientPolicyResponse' + - $ref: '#/components/schemas/_errorContextResponse' + SmbClientPolicyResponse: + type: object + properties: + items: + description: A list of SMB Client policy objects. + type: array + items: + $ref: '#/components/schemas/SmbClientPolicy' + SmbClientPolicyRulePost: + allOf: + - $ref: '#/components/schemas/SmbClientPolicyRulePostBase' + - $ref: '#/components/schemas/_policyRuleIndex' + SmbClientPolicyRule: + allOf: + - $ref: '#/components/schemas/SmbClientPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndex' + - $ref: '#/components/schemas/_context' + SmbClientPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SmbClientPolicyRuleResponse' + - $ref: '#/components/schemas/_errorContextResponse' + SmbClientPolicyRuleResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SmbClientPolicyRule' + SmbSharePolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + rules: + description: | + All of the rules that are part of this policy. + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbSharePolicyRulePost' + SmbSharePolicyPatch: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - type: object + properties: + rules: + description: | + All of the rules that are part of this policy. + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbSharePolicyRule' + SmbSharePolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SmbSharePolicyResponse' + - $ref: '#/components/schemas/_errorContextResponse' + SmbSharePolicyResponse: + type: object + properties: + items: + description: A list of SMB Share policy objects. + type: array + items: + $ref: '#/components/schemas/SmbSharePolicy' + SmbSharePolicyRulePost: + allOf: + - $ref: '#/components/schemas/_builtIn' + - 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`. + 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`. + 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`. + 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`. + type: string + SmbSharePolicyRule: + allOf: + - $ref: '#/components/schemas/_builtIn' + - 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`, and + clears the Full Control permission if it is currently `allow`. This is + incompatible with explicitly setting any permission to `allow`. + If set to an empty string (`""`), the value (and implicitly the Full + Control permission) will be cleared. This is incompatible with + explicitly setting the Full Control permission to `allow` or `deny`. + 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`. + If set to an empty string (`""`), the value will be cleared. + type: string + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + principal: + description: | + The user or group who is the subject of this rule, and their domain. + If modifying this value, providing the domain is optional. If no domain + is provided, it will be derived if possible. + For example, `PURESTORAGE\Administrator`, `samplegroup@PureStorage`, or + `sampleuser`. + 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. + If set to `allow`, implicitly clears the Full Control and Change + permissions if they are currently `deny`. This is incompatible with + explicitly setting any permission to `deny`. + If set to `deny`, implicitly clears the Full Control and Change + permissions if they are currently `allow`. This is incompatible with + explicitly setting any permission to `allow`. + type: string + SmbSharePolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SmbSharePolicyRuleResponse' + - $ref: '#/components/schemas/_errorContextResponse' + SmbSharePolicyRuleResponse: + type: object + properties: + items: + description: A list of SMB Share policy rule objects. + type: array + items: + $ref: '#/components/schemas/SmbSharePolicyRuleWithContext' + SmtpServer: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + encryption_mode: + description: | + Enforces an encryption mode when sending alert email messages. + Valid values include `starttls`. + Use "" to clear. + type: string + example: starttls + 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 + SmtpServerGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SmtpServerResponse' + SmtpServerResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SmtpServer' + SnmpAgent: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + engine_id: + description: | + An SNMP agent's adminstration domain unique name. + 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 an SNMP manager + in communications with Purity's SNMP agent. + 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' + SnmpAgentMibResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SnmpAgentMib' + SnmpManagerPost: + type: object + properties: + host: + description: | + DNS hostname or IP address of a computer that hosts an SNMP manager + to which Purity 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 in communications + with the specified manager. + Valid values are `v2c` and `v3`. + type: string + example: v3 + SnmpManager: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + host: + description: | + DNS hostname or IP address of a computer that hosts an SNMP manager + to which Purity 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 in communications + 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' + TestResultGetResponse: + allOf: + - $ref: '#/components/schemas/TestResultResponse' + - type: object + properties: + total_item_count: + description: Total number of items after applying `filter` params. + type: integer + format: int32 + SshCertificateAuthorityPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + signing_authority: + description: | + A reference to the authority that will digitally sign user SSH certificates that will be + used to access the system. + This may be either a certificate or a public key. If a certificate is used as the signer, + then its expiry period will be honored and user SSH certificates signed by the certificate + will no longer be accepted after the certificate has expired. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + static_authorized_principals: + description: | + If not specified - users affected by this policy can only log into the system when they + present an SSH certificate containing their own username as a principle. + If specified - users affected by this policy can only log into the system when they + present an SSH certificate containing at least one username from this list as a + principle. + type: array + maxItems: 16 + items: + maxLength: 128 + type: string + description: | + A specific principal that can be used to permit login to user accounts to whom this + policy applies. Principals must be comprised of UTF-8 encoded characters and may + not contain any of the following: `"`, `,`, `/`, newline character, or other similar + escape characters. + SshCertificateAuthorityPolicy: + allOf: + - $ref: '#/components/schemas/SshCertificateAuthorityPolicyPost' + - $ref: '#/components/schemas/PolicyBaseRenameable' + SshCertificateAuthorityPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SshCertificateAuthorityPolicyResponse' + SshCertificateAuthorityPolicyResponse: + type: object + properties: + items: + description: A list of SSH certificate authority policy objects. + type: array + items: + $ref: '#/components/schemas/SshCertificateAuthorityPolicy' + Subnet: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + enabled: + description: | + Indicates if subnet is enabled (`true`) or disabled (`false`). + If not specified, defaults to `true`. + type: boolean + readOnly: true + gateway: + description: | + The IPv4 or IPv6 address of the gateway through which the specified + subnet is to communicate with the network. + type: string + interfaces: + description: List of network interfaces associated with this subnet. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + link_aggregation_group: + description: Reference to the associated LAG. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + 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 + example: 1.2.3.0/24 + 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 `data`, `management`, `replication`, and `support`. + vlan: + description: VLAN ID. + type: integer + format: int32 + SubnetGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SubnetResponse' + SubnetResponse: + type: object + properties: + items: + description: A list of subnet objects. + type: array + items: + $ref: '#/components/schemas/Subnet' + Support: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + edge_agent_update_enabled: + description: The switch to enable opt-in for edge agent updates. + type: boolean + edge_management_enabled: + description: The switch to enable opt-in for edge management. + type: boolean + phonehome_enabled: + description: The switch to enable phonehome. + type: boolean + proxy: + type: string + remote_assist_active: + description: The switch to open all remote-assist sessions. + 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 time when the session expires. + type: string + readOnly: true + remote_assist_opened: + description: The time when the session opened. + type: string + readOnly: true + remote_assist_paths: + type: array + readOnly: true + items: + $ref: '#/components/schemas/_support_remote_assist_paths' + remote_assist_status: + description: | + The status of the remote-assist sessions. + Valid values are `connected`, `partially_connected`, `reconnecting`, + and `disconnected`. + type: string + readOnly: true + example: connected + SupportGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SupportResponse' + SupportResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Support' + VerificationKeyPatch: + type: object + properties: + signed_verification_key: + description: The text of the signed verification key. + type: string + VerificationKeyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/VerificationKeyResponse' + VerificationKeyResponse: + type: object + properties: + items: + description: A list of verification key objects. + type: array + items: + $ref: '#/components/schemas/VerificationKey' + SupportDiagnosticsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SupportDiagnosticsResponse' + SupportDiagnosticsDetailsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SupportDiagnosticsDetailsResponse' + SoftwareChecksGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SoftwareChecksResponse' + SoftwareChecksResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SoftwareCheck' + SyslogServerPost: + allOf: + - $ref: '#/components/schemas/SyslogServerPostOrPatch' + - type: object + properties: + services: + description: | + Valid values are `data-audit` and `management`. + If not specified, defaults to `management`. + type: array + items: + type: string + sources: + description: | + The network interfaces used for communication with the syslog server. + The network interfaces must have the `services` value of `data`. + Only network interfaces within default array realm are supported. + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/_reference' + SyslogServerPatch: + allOf: + - $ref: '#/components/schemas/SyslogServerPostOrPatch' + - type: object + properties: + services: + description: | + Valid values are `data-audit` and `management`. + type: array + items: + type: string + sources: + description: | + The network interfaces used for communication with the syslog server. + The network interfaces must have the `services` value of `data`. + Only network interfaces within default array realm are supported. + Clear this by setting an empty list. + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/_reference' + SyslogServerGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SyslogServerContextResponse' + - $ref: '#/components/schemas/_errorContextResponse' + SyslogServerResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SyslogServer' + SyslogServerSettings: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: Global settings for syslog servers. + type: object + properties: + ca_certificate: + type: object + allOf: + - $ref: '#/components/schemas/_reference' + - description: | + CA certificate used to validate the authenticity of the configured + servers. + type: object + ca_certificate_group: + type: object + allOf: + - $ref: '#/components/schemas/_reference' + - description: | + A certificate group containing CA certificates that can be used to + validate the authenticity of the configured servers. + type: object + SyslogServerSettingsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SyslogServerSettingsResponse' + SyslogServerSettingsResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SyslogServerSettings' + TargetPost: + type: object + properties: + address: + description: IP address or FQDN of the target system. + type: string + Target: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + address: + description: IP address or FQDN of the target system. + type: string + ca_certificate_group: + description: | + The group of CA certificates that can be used, in addition to + well-known Certificate Authority certificates, in order to + establish a secure connection to the target system. + Defaults to a reference to the `_default_replication_certs` group. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + status: + description: | + Status of the connection. + Valid values are `connected` and `connecting`. + `connected` - The connection is OK. + `connecting` - No connection exists and the array is trying to + reconnect to the target. + 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 + TargetGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/TargetResponseContext' + - $ref: '#/components/schemas/_errorContextResponse' + TargetResponse: + type: object + properties: + items: + description: A list of target objects. + type: array + items: + $ref: '#/components/schemas/Target' + ResourcePerformanceReplicationGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ResourcePerformanceReplication' + total: + description: | + Total of all records after filtering. + If `total_only` query param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/ResourcePerformanceReplication' + TlsPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + appliance_certificate: + description: | + A reference to a certificate that will be presented as the server certificate + in TLS negotiations with any clients that connect to appliance network addresses + to which this policy applies. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + client_certificates_required: + description: | + If `true`, then all clients negotiating TLS connections with network + interfaces to which this policy applies will be required to provide + their client certificates during TLS negotiation. Any client's failure + to provide a certificate will cause the TLS negotiation to be + rejected. + If `false`, then providing a client certificate in TLS negotiation is + not mandatory, and TLS negotiation can succeed when none is provided. + If not specified, defaults to `false`. + type: boolean + disabled_tls_ciphers: + description: | + If specified, disables the specific TLS ciphers. If all TLS ciphers + that are available for a specific TLS version on the system are disabled, then client + access over that TLS version is not possible. As such, disabled ciphers must still + result in at least one cipher being available for each enabled TLS version. + Changes to this setting can disrupt traffic for any clients relying on disabled + ciphers. + type: array + maxItems: 16 + items: + maxLength: 128 + type: string + description: | + A specific TLS cipher or TLS cipher component to disable, in openssl format. + For example, `AES128` would disable all TLS ciphers that utilize the `AES128` + algorithm for encryption, while `ECDHE-ECDSA-AES256-CCM` would disable + that specific cipher. + enabled_tls_ciphers: + description: | + If specified, enables only the specified TLS ciphers. If all TLS ciphers + that are available for a specific TLS version on the system are disabled, then client + access over that TLS version is not possible. As such, the enabled ciphers must always + contain at least one cipher for each enabled TLS version. + Changes to this setting can disrupt traffic for any clients relying on ciphers that + are removed. If set to `default`, then the enabled ciphers may be automatically adjusted + upon upgrade to newer software in order to align with the best known practices at the + time of software release. + type: array + maxItems: 16 + items: + maxLength: 128 + type: string + description: | + A specific TLS cipher or TLS cipher component to enable, in openssl format. + For example, `AES128` would enable all strong TLS ciphers that utilize the `AES128` + algorithm for encryption, while `AES128-SHA` would enable that specific cipher. + min_tls_version: + description: | + The minimum TLS version that will be allowed for inbound connections on IPs to + which this policy applies. Changing this setting can disrupt connections for + any clients relying on older TLS versions that are disabled. + If set to `default`, then the lowest TLS version permitted may be automatically + raised upon upgrade to newer software in order to align with the best known + practices at the time of software release. + Configuring an explicit, low value can prevent upgrades to newer software + versions that no longer support older TLS versions. + Valid values include `default`, `TLSv1.1`, `TLSv1.0`, `TLSv1.2`, + and `TLSv1.3`. + type: string + trusted_client_certificate_authority: + description: | + A reference to a certificate or certificate group. + The certificate referenced, or the certificates in the referenced group, + will be used to verify the certificates presented by clients when + `verify_client_certificate_trust` is `true`. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + verify_client_certificate_trust: + description: | + If `true`, then any certificate presented by a client in TLS negotiation + will undergo strict trust verification using the certificate(s) referenced + by `trusted_client_certificate_authority`. + If `false`, then certificates presented by clients in TLS negotiation + will only be checked to ensure they're properly constructed and non-expired, + and the certificates specified by `trusted_client_certificate_authority` will + not be used. Details of client certificates may still be recorded for certain + audit purposes, even if they do not undergo trust verification. + If `client_certificates_required` is `false`, and no client certificate is + provided during TLS negotiation, then no trust verification will be performed; + if a client chooses to provide a certificate, even when not required, and + this field is `true`, then the certificate will undergo trust verification. + If not specified, defaults to `false`. + type: boolean + TlsPolicy: + allOf: + - $ref: '#/components/schemas/TlsPolicyPost' + - $ref: '#/components/schemas/PolicyBaseRenameable' + TlsPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/TlsPolicyResponse' + TlsPolicyResponse: + type: object + properties: + items: + description: A list of TLS policy objects. + type: array + items: + $ref: '#/components/schemas/TlsPolicy' + 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/PageInfo' + - $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: FixedReferenceWithoutType + allOf: + - $ref: '#/components/schemas/_fixedReferenceWithoutType' + 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' + - $ref: '#/components/schemas/_errorContextResponse' + WorkloadPlacementRecommendationResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/WorkloadPlacementRecommendation' + TagGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/TagResponse' + - $ref: '#/components/schemas/_errorContextResponse' + 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: ReferenceWithoutType + allOf: + - $ref: '#/components/schemas/_referenceWithoutType' + 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' + WormDataPolicy: + allOf: + - $ref: '#/components/schemas/SnapshotWormDataPolicyBase' + - $ref: '#/components/schemas/_wormDataPolicyRetentionConfig' + - $ref: '#/components/schemas/_context' + - type: object + properties: + realms: + description: | + The realms containing this worm data policy. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + WormDataPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/WormDataPoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + WormDataPoliciesResponse: + type: object + properties: + items: + description: A list of worm data policy objects. + type: array + items: + $ref: '#/components/schemas/WormDataPolicy' + _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" + ActiveDirectoryDirectoryServers: + type: object + properties: + directory_servers: + description: | + A list of directory servers that will be used for lookups related to user authorization. + Accepted server formats are IP address and DNS name with optional @domain suffix. + If the suffix is ommited, the joined domain is assumed. + All specified servers must be registered to the domain appropriately in the array's + configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. + The specified list can have a maximum length of 50. + type: array + maxItems: 50 + items: + type: string + example: ldap.my-corporation.com + global_catalog_servers: + description: | + A list of global catalog servers that will be used for lookups related to user authorization. + Accepted server formats are IP address and DNS name with optional @domain suffix. + If the suffix is ommited, the joined domain is assumed. + All specified servers must be registered to the domain appropriately in the array's + configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. + The specified list can have a maximum length of 50. + type: array + maxItems: 50 + items: + type: string + example: gc.my-corporation.com + 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 + total_item_count: + description: Total number of items after applying `filter` params. + type: integer + format: int32 + ActiveDirectory: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + computer_name: + description: | + The common 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: FLASHBLADE01 + directory_servers: + description: | + A list of directory servers that will be used for lookups related to user authorization. + Accepted server formats are IP address and DNS name with optional @domain suffix. + If the suffix is ommited, the joined domain is assumed. + All specified servers must be registered to the domain appropriately in the array's + configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. + type: array + items: + type: string + example: ldap.my-corporation.com + domain: + description: The Active Directory domain to join. + type: string + example: my-corporation.com + encryption_types: + description: | + The encryption types that are supported for use by clients for Kerberos + authentication. + type: array + items: + type: string + example: aes256-cts-hmac-sha1-96 + global_catalog_servers: + description: | + A list of global catalog servers that will be used + for lookups related to user authorization. + Accepted server formats are IP address and DNS name with optional @domain suffix. + If the suffix is ommited, the joined domain is assumed. + All specified servers must be registered to the domain appropriately in the array's + configured DNS and will only be communicated with over the secure LDAP (LDAPS) protocol. + type: array + items: + type: string + example: gc.my-corporation.com + join_ou: + description: | + The relative distinguished name of the organizational unit in which the + computer account was created when joining the domain. + type: string + example: CN=Computers + kerberos_servers: + description: | + A list of key distribution servers to use for Kerberos protocol. + Accepted server formats are IP address and DNS name. + All specified servers must be registered to the domain appropriately in the array's + configured DNS. + type: array + items: + type: string + example: krb-host.my-corporation.com + realms: + description: | + The realms containing this active directory account. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + server: + description: | + The server containing this active directory account. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + service_principal_names: + description: | + A list of service principal names registered for the machine account, + which can be used for the creation of keys for Kerberos authentication. + type: array + items: + pattern: (service)/(fqdn) + type: string + example: nfs/vip1.my-array.my-corporation.com + _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' + _referenceWritable: + allOf: + - $ref: '#/components/schemas/_referenceWithoutType' + - type: object + properties: + resource_type: + description: | + Type of the object (full name of the endpoint). + Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, + `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, + `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and + `policies/snapshot`, etc. + type: string + x-aliases: + - _reference + Admin: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + api_token: + $ref: '#/components/schemas/_apiToken' + is_local: + description: "Returns a value of `true` if the user is local to the machine, otherwise `false`." + type: boolean + readOnly: true + locked: + description: | + Returns a value of `true` if the user is currently locked out, otherwise `false`. + Can be patched 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, in milliseconds, if the user is locked out. + 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. + readOnly: true # Prevent Patch calls. Use /admins/management-access-policies instead. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + public_key: + description: Public key for SSH access. Supported key types are `Ed25519` and `RSA`. + type: string + role: + description: | + Deprecated. + `role` is deprecated in favor of `management_access_policies`, but remains for + backwards compatibility. If an administrator has exactly one access policy which + corresponds to a valid legacy role of the same name, `role` will be a + reference to that role. + Otherwise, it will be `null`. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + AdminApiToken: + type: object + properties: + admin: + description: A reference to the admin to whom this token belongs. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + api_token: + title: ApiToken + allOf: + - $ref: '#/components/schemas/_apiToken' + x-readOnly: true + AdminCache: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + management_access_policies: + description: | + List of management access policies associated with the administrator. + readOnly: true # Prevent Patch calls. Use /admins/management-access-policies instead. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + role: + description: | + Deprecated. + `role` is deprecated in favor of `management_access_policies`, but remains for + backwards compatibility. If an administrator has exactly one access policy which + corresponds to a valid legacy role of the same name, `role` will be a + reference to that role. + Otherwise, it will be `null`. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + time: + description: | + Time the role was cached in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + x-readOnly: true + PolicyMember: + type: object + properties: + member: + description: Reference to the resource the policy is applied to. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy: + description: Reference to the policy. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + PolicyMemberContext: + allOf: + - $ref: '#/components/schemas/PolicyMember' + - $ref: '#/components/schemas/_context' + _builtIn: + type: object + properties: + id: + description: | + A non-modifiable, globally unique ID chosen by the system. + type: string + readOnly: true + name: + description: "Name of the object (e.g., a file system or snapshot)." + type: string + readOnly: true + 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: fm1 + 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: Is the service enabled or not? + type: boolean + example: true + resource: + description: A reference to the object being tested. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + result_details: + description: Additional information about the test result. + type: string + example: Timeout connecting to phonehome endpoint + success: + description: | + Returns a value of `true` if the specified test succeeded. + Returns a value of `false` if the specified test 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. + type: string + example: phonehome + _fixedReference: + allOf: + - $ref: '#/components/schemas/_fixedReferenceWithoutType' + - type: object + properties: + resource_type: + description: | + Type of the object (full name of the endpoint). + Valid values are the unique part of the resource's REST endpoint. + For example, a reference to a file system would have a + `resource_type` of `file-systems`. + type: string + readOnly: true + _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 + _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: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + _arrayEncryption: + type: object + properties: + data_at_rest: + title: ArrayEncryptionDataAtRest + allOf: + - $ref: '#/components/schemas/_arrayEncryptionDataAtRest' + x-readOnly: true + _arrayEradicationConfig: + type: object + properties: + eradication_delay: + description: | + The file eradication delay is in milliseconds. + Automatically eradicate destroyed filesystems and snapshots after the delay time. + Valid values are `86400000` and any multiple of `86400000` + in the range of `86400000` and `2592000000`. + Any other values will be rounded down to the + nearest multiple of `86400000`. + type: integer + format: int64 + readOnly: true + example: 86400000 + manual_eradication: + description: | + Manual eradication status is applied on the array level. + If status is all-disabled, you cannot eradicate buckets and file systems. + If status is file-disabled then you can not eradicate files systems. + If status is object-disabled then you can not eradicate buckets. + If status is all-enabled then you can eradicate file systems and buckets. + Values include `all-enabled`, `file-disabled`, + `object-disabled`, and `all-disabled`. + type: string + readOnly: true + ClientsPerformance: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + bytes_per_op: + description: | + Average operation size (read bytes+write bytes/read ops+write ops). + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read request. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write request. + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + ClientsS3SpecificPerformance: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + read_buckets_per_sec: + description: Read buckets requests processed per second. + type: number + format: double + minimum: 0 + read_objects_per_sec: + description: Read object requests processed per second. + type: number + format: double + minimum: 0 + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + usec_per_read_bucket_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read bucket request. + type: number + format: double + minimum: 0 + usec_per_read_object_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read object request. + type: number + format: double + minimum: 0 + usec_per_write_bucket_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write bucket request. + type: number + format: double + minimum: 0 + usec_per_write_object_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write object request. + type: number + format: double + minimum: 0 + write_buckets_per_sec: + description: Write buckets requests processed per second. + type: number + format: double + minimum: 0 + write_objects_per_sec: + description: Write object requests processed per second. + type: number + format: double + minimum: 0 + _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/_builtInNoId' + - 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 7-digit number required as input to perform a factory reset of the array. + type: integer + format: int64 + readOnly: true + example: 5671919 + _throttle: + description: | + The bandwidth throttling for an array connection or target. + 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 + _builtInRelationship: + type: object + properties: + id: + description: | + A non-modifiable, globally unique ID chosen by the system. + type: string + readOnly: true + ArrayConnectionKey: + type: object + properties: + connection_key: + description: | + Connection-key, used on another array to connect to this array. + After creation, listing will only show ****. + type: string + readOnly: true + example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 + created: + description: Creation time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + expires: + description: Expiration time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + x-readOnly: true + ArrayConnectionPath: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - $ref: '#/components/schemas/_context' + - description: | + Path from a source array to a destination array. + `id` is the `id` of the array connection. + type: object + properties: + destination: + description: | + IP address with the port of the target array. + type: string + readOnly: true + example: 10.202.101.70:443 + remote: + description: | + The remote array. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + source: + description: | + IP address of the source array. + type: string + readOnly: true + example: 10.202.101.70 + status: + description: | + Status of the connection. + Valid values are `connected` and `connecting`. + `connected` - The connection is OK. + `connecting` - No connection exists and the array is trying to + reconnect. + 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` and `fleet-management`. + type: string + ConnectionRelationshipPerformanceReplication: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - type: object + properties: + aggregate: + description: | + Total bytes transmitted or received per second for all types of + replication. + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + continuous: + description: | + Object backlog information and total bytes transmitted or received + per second for continuous replication. Continuous replication + includes object replication. + title: ContinuousReplicationPerformance + allOf: + - $ref: '#/components/schemas/_continuousReplicationPerformance' + periodic: + description: | + Total bytes transmitted or received per second for periodic + replication. Periodic replication includes file system replication, + which is snapshot based. + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + remote: + description: Reference to a remote array. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + x-readOnly: true + ArrayHttpSpecificPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + read_dirs_per_sec: + description: Read directory requests processed per second. + type: number + format: double + minimum: 0 + read_files_per_sec: + description: Read file requests processed per second. + type: number + format: double + minimum: 0 + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + usec_per_read_dir_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read directory request. + type: number + format: double + minimum: 0 + usec_per_read_file_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read file request. + type: number + format: double + minimum: 0 + usec_per_write_dir_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write directory request. + type: number + format: double + minimum: 0 + usec_per_write_file_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write file request. + type: number + format: double + minimum: 0 + write_dirs_per_sec: + description: Write directory requests processed per second. + type: number + format: double + minimum: 0 + write_files_per_sec: + description: Write file requests processed per second. + type: number + format: double + minimum: 0 + ArrayNfsSpecificPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + accesses_per_sec: + description: ACCESS requests processed per second. + type: number + format: double + minimum: 0 + aggregate_file_metadata_creates_per_sec: + description: | + Sum of file-level or directory-level create-like metadata requests per + second. Includes CREATE, LINK, MKDIR, and SYMLINK. + type: number + format: double + minimum: 0 + aggregate_file_metadata_modifies_per_sec: + description: | + Sum of file-level or directory-level modify-like and delete-like + metadata requests per second. Includes REMOVE, RENAME, RMDIR, and + SETATTR. + type: number + format: double + minimum: 0 + aggregate_file_metadata_reads_per_sec: + description: | + Sum of file-level or directory-level read-like metadata requests per + second. Includes GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and + READLINK. + type: number + format: double + minimum: 0 + aggregate_other_per_sec: + description: | + Sum of all other requests processed per second. This includes COMMIT, + MKNOD, NULL, NLM operations, and operations which are supported for + NFSv4.1 but not NFSv3. + type: number + format: double + minimum: 0 + aggregate_share_metadata_reads_per_sec: + description: | + Sum of share-level read-like metadata requests per second. + Includes ACCESS, FSINFO, and FSSTAT. + type: number + format: double + minimum: 0 + aggregate_usec_per_file_metadata_create_op: + description: | + Average time, measured in microseconds, it takes the array to process a + file-level or directory-level create-like metadata request. Includes + CREATE, LINK, MKDIR, and SYMLINK. + type: number + format: double + minimum: 0 + aggregate_usec_per_file_metadata_modify_op: + description: | + Average time, measured in microseconds, it takes the array to process a + file-level or directory-level modify-like or delete-like metadata + request. Includes REMOVE, RENAME, RMDIR, and SETATTR. + type: number + format: double + minimum: 0 + aggregate_usec_per_file_metadata_read_op: + description: | + Average time, measured in microseconds, it takes the array to process a + file-level or directory-level read-like metadata request. Includes + GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and READLINK. + type: number + format: double + minimum: 0 + aggregate_usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + all other requests. This includes COMMIT, MKNOD, NULL, NLM operations, + and operations which are supported for NFSv4.1 but not NFSv3. + type: number + format: double + minimum: 0 + aggregate_usec_per_share_metadata_read_op: + description: | + Average time, measured in microseconds, it takes the array to process a + share-level read-like metadata request. Includes ACCESS, FSINFO, and + FSSTAT. + type: number + format: double + minimum: 0 + creates_per_sec: + description: CREATE requests processed per second. + type: number + format: double + minimum: 0 + fsinfos_per_sec: + description: FSINFO requests processed per second. + type: number + format: double + minimum: 0 + fsstats_per_sec: + description: FSSTAT requests processed per second. + type: number + format: double + minimum: 0 + getattrs_per_sec: + description: GETATTR requests processed per second. + type: number + format: double + minimum: 0 + links_per_sec: + description: LINK requests processed per second. + type: number + format: double + minimum: 0 + lookups_per_sec: + description: LOOKUP requests processed per second. + type: number + format: double + minimum: 0 + mkdirs_per_sec: + description: MKDIR requests processed per second. + type: number + format: double + minimum: 0 + pathconfs_per_sec: + description: PATHCONF requests processed per second. + type: number + format: double + minimum: 0 + readdirpluses_per_sec: + description: READDIRPLUS requests processed per second. + type: number + format: double + minimum: 0 + readdirs_per_sec: + description: READDIR requests processed per second. + type: number + format: double + minimum: 0 + readlinks_per_sec: + description: READLINK requests processed per second. + type: number + format: double + minimum: 0 + reads_per_sec: + description: READ requests processed per second. + type: number + format: double + minimum: 0 + removes_per_sec: + description: REMOVE requests processed per second. + type: number + format: double + minimum: 0 + renames_per_sec: + description: RENAME requests processed per second. + type: number + format: double + minimum: 0 + rmdirs_per_sec: + description: RMDIR requests processed per second. + type: number + format: double + minimum: 0 + setattrs_per_sec: + description: SETATTR requests processed per second. + type: number + format: double + minimum: 0 + symlinks_per_sec: + description: SYMLINK requests processed per second. + type: number + format: double + minimum: 0 + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + usec_per_access_op: + description: | + Average time, measured in microseconds, it takes the array to process + an ACCESS request. + type: number + format: double + minimum: 0 + usec_per_create_op: + description: | + Average time, measured in microseconds, it takes the array to process + a CREATE request. + type: number + format: double + minimum: 0 + usec_per_fsinfo_op: + description: | + Average time, measured in microseconds, it takes the array to process + an FSINFO request. + type: number + format: double + minimum: 0 + usec_per_fsstat_op: + description: | + Average time, measured in microseconds, it takes the array to process + an FSSTAT request. + type: number + format: double + minimum: 0 + usec_per_getattr_op: + description: | + Average time, measured in microseconds, it takes the array to process + a GETATTR request. + type: number + format: double + minimum: 0 + usec_per_link_op: + description: | + Average time, measured in microseconds, it takes the array to process + a LINK request. + type: number + format: double + minimum: 0 + usec_per_lookup_op: + description: | + Average time, measured in microseconds, it takes the array to process + a LOOKUP request. + type: number + format: double + minimum: 0 + usec_per_mkdir_op: + description: | + Average time, measured in microseconds, it takes the array to process + a MKDIR request. + type: number + format: double + minimum: 0 + usec_per_pathconf_op: + description: | + Average time, measured in microseconds, it takes the array to process + a PATHCONF request. + type: number + format: double + minimum: 0 + usec_per_read_op: + description: | + Average time, measured in microseconds, it takes the array to process + a READ request. + type: number + format: double + minimum: 0 + usec_per_readdir_op: + description: | + Average time, measured in microseconds, it takes the array to process + a READDIR request. + type: number + format: double + minimum: 0 + usec_per_readdirplus_op: + description: | + Average time, measured in microseconds, it takes the array to process + a READDIRPLUS request. + type: number + format: double + minimum: 0 + usec_per_readlink_op: + description: | + Average time, measured in microseconds, it takes the array to process + a READLINK request. + type: number + format: double + minimum: 0 + usec_per_remove_op: + description: | + Average time, measured in microseconds, it takes the array to process + a REMOVE request. + type: number + format: double + minimum: 0 + usec_per_rename_op: + description: | + Average time, measured in microseconds, it takes the array to process + a RENAME request. + type: number + format: double + minimum: 0 + usec_per_rmdir_op: + description: | + Average time, measured in microseconds, it takes the array to process + an RMDIR request. + type: number + format: double + minimum: 0 + usec_per_setattr_op: + description: | + Average time, measured in microseconds, it takes the array to process + a SETATTR request. + type: number + format: double + minimum: 0 + usec_per_symlink_op: + description: | + Average time, measured in microseconds, it takes the array to process + a SYMLINK request. + type: number + format: double + minimum: 0 + usec_per_write_op: + description: | + Average time, measured in microseconds, it takes the array to process + a WRITE request. + type: number + format: double + minimum: 0 + writes_per_sec: + description: WRITE requests processed per second. + type: number + format: double + minimum: 0 + ArrayPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + bytes_per_op: + description: | + Average operation size (read bytes+write bytes/read ops+write ops). + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read request. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write request. + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + RelationshipPerformanceReplication: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - $ref: '#/components/schemas/_context' + - type: object + properties: + aggregate: + description: | + Total bytes transmitted or received per second for all types of + replication. + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + continuous: + description: | + Object backlog information and total bytes transmitted or received + per second for continuous replication. Continuous replication + includes object replication. + title: ContinuousReplicationPerformance + allOf: + - $ref: '#/components/schemas/_continuousReplicationPerformance' + periodic: + description: | + Total bytes transmitted or received per second for periodic + replication. Periodic replication includes file system replication, + which is snapshot based. + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + x-readOnly: true + ArrayS3SpecificPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + read_buckets_per_sec: + description: Read buckets requests processed per second. + type: number + format: double + minimum: 0 + read_objects_per_sec: + description: Read object requests processed per second. + type: number + format: double + minimum: 0 + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + usec_per_read_bucket_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read bucket request. + type: number + format: double + minimum: 0 + usec_per_read_object_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read object request. + type: number + format: double + minimum: 0 + usec_per_write_bucket_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write bucket request. + type: number + format: double + minimum: 0 + usec_per_write_object_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write object request. + type: number + format: double + minimum: 0 + write_buckets_per_sec: + description: Write buckets requests processed per second. + type: number + format: double + minimum: 0 + write_objects_per_sec: + description: Write object requests processed per second. + type: number + format: double + minimum: 0 + ArraySpace: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + capacity: + description: Usable capacity in bytes. + type: integer + format: int64 + example: 10995116277760 + parity: + description: | + A representation of data redundancy on the array. + Data redundancy is rebuilt automatically by the system whenever parity is less than 1.0. + type: number + format: float + example: 0.99 + space: + $ref: '#/components/schemas/_space' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + StorageClassSpace: + allOf: + - $ref: '#/components/schemas/_fixedReferenceNameOnly' + - type: object + properties: + capacity: + description: Usable capacity in bytes. + type: integer + format: int64 + example: 10995116277760 + space: + $ref: '#/components/schemas/_space' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + _timeZone: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + ArrayErasure: + allOf: + - $ref: '#/components/schemas/_resourceNoId' + - description: | + Status and detailed information of the factory reset process. + type: object + properties: + details: + description: | + The detailed reason of the `status`. + type: string + 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 + example: "NIST SP800-88R1 section 4.8 ..." + status: + description: | + The status of the factory reset process. + A status of `resetting` indicates that the factory reset is running - wiping user data. + A status of `failed` indicates that the factory reset encountered a failure. + A status of `waiting_for_finalize` indicates that the factory reset has + finished - waiting for the user to finalize the factory reset. + type: string + example: "resetting" + AuditResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Audit' + AuditFileSystemsPolicyNoContext: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_resource' + - properties: + control_type: + type: string + description: | + Specifies the evaluation mode for auditing in this policy. + Valid values are "policy", "sacl". If not specified, the default value is "sacl". + log_targets: + description: | + List of targets which will be utilized for audit log storage. + These may either be file system targets or remote syslog server targets. + type: array + items: + $ref: '#/components/schemas/_reference' + rules: + type: array + maxItems: 2 + items: + $ref: '#/components/schemas/AuditFileSystemsPolicyRuleInPolicy' + description: | + All of the rules that are part of this policy. + AuditFileSystemsPolicyPatchBase: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_resource' + - properties: + log_targets: + description: | + List of targets which will be utilized for audit log storage. + These may either be file system targets or remote syslog server targets. + type: array + items: + $ref: '#/components/schemas/_reference' + rules: + type: array + maxItems: 2 + items: + $ref: '#/components/schemas/AuditFileSystemsPolicyRuleInPolicy' + description: | + All of the rules that are part of this policy. + _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 + 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 + x-aliases: + - _referenceWithFixedType + AuditFileSystemsPolicy: + allOf: + - $ref: '#/components/schemas/AuditFileSystemsPolicyNoContext' + - $ref: '#/components/schemas/_context' + - type: object + properties: + control_type: + type: string + description: | + Specifies the evaluation mode for auditing in this policy. + Valid values are "policy", "sacl". If not specified, the default value is "sacl". + log_targets: + description: | + List of targets which will be utilized for audit log storage. + These may either be file system targets or remote syslog server targets. + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + rules: + type: array + maxItems: 2 + items: + $ref: '#/components/schemas/AuditFileSystemsPolicyRuleInPolicy' + description: | + All of the rules that are part of this policy. + AuditFileSystemsPolicyOperationResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/AuditFileSystemsPolicyOperation' + AuditObjectStorePolicyWithWritableReference: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_resource' + - type: object + properties: + log_targets: + description: | + List of targets which will be utilized for audit log storage. + These may either be bucket targets or remote syslog server targets. + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + AuditObjectStorePolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_resource' + - type: object + properties: + log_targets: + description: | + List of targets which will be utilized for audit log storage. + These may either be bucket targets or remote syslog server targets. + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + AuditObjectStorePolicyWithContext: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/AuditObjectStorePolicy' + Blade: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + details: + type: string + readOnly: true + progress: + type: number + format: float + readOnly: true + raw_capacity: + type: integer + format: int64 + readOnly: true + status: + description: | + Valid values are `critical`, `evacuated`, `evacuating`, `healthy`, + `identifying`, `unhealthy`, `unknown`, and `unused`. + type: string + readOnly: true + target: + type: string + readOnly: true + BucketAuditFilterActionResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/BucketAuditFilterActionWithContext' + _bucketEradicationConfig: + description: Configuration settings related to bucket eradication. + type: object + properties: + eradication_delay: + description: | + Minimum eradication delay in milliseconds. Automatically eradicate destroyed + buckets after the delay time passes unless automatic eradication + is delayed due to other configuration values. + type: integer + format: int64 + readOnly: true + example: 86400000 + eradication_mode: + description: | + The eradication mode of the bucket. + If it's `permission-based` the bucket can be eradicated based + on user permissions. + If it's `retention-based` the bucket can never be eradicated as long + as there are locked objects still being retained. + Valid values are `permission-based` and `retention-based`. + type: string + example: permission-based + manual_eradication: + description: | + The manual eradication status of the bucket. + If `disabled`, the bucket cannot be eradicated after it has been + destroyed, unless it is empty. + If `enabled`, the bucket can be eradicated. + Valid values are `disabled` and `enabled`. + type: string + readOnly: true + example: enabled + _objectLockConfigRequestBody: + allOf: + - $ref: '#/components/schemas/_objectLockConfigBase' + - type: object + properties: + default_retention: + description: | + The retention period, in milliseconds, used to apply locks + on new objects if none is specified by the S3 client. + Valid values are any multiple of `86400000` (1 day), up to + `3153600000000` (36500 days). + If there is no default, this value is `null`. + Use "" to clear. + type: string + example: "86400000" + _publicAccessConfig: + description: Configuration settings related to public access. + type: object + properties: + block_new_public_policies: + description: | + If set to `true`, adding bucket policies that grant public access to a bucket is not allowed. + type: boolean + block_public_access: + description: | + If set to `true`, access to a bucket with a public policy is restricted to only authenticated + users within the account that bucket belongs to. + type: boolean + StorageClassInfo: + allOf: + - $ref: '#/components/schemas/_referenceNameOnly' + - type: object + properties: + status: + description: "The status of the transition from the policy to the requested policy. If there + is an ongoing transition, the status will be one of `In-Progress` or `Queued`. If there + is no transition ongoing, this field will be null." + type: string + readOnly: true + status_details: + description: "Additional details about the status of the transition. If there is no transition + ongoing, this field will be null." + type: string + readOnly: true + tiering_policy: + description: | + The storage class tiering policy defines tiering for data within the container. If specified, + data is written to the container's `S500X-S` (speed) storage class by default, then tiered + to `S500X-A` (archival) storage class based on the policy. + If not specified, all data in the container is written to the container's current storage class. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + Bucket: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + account: + $ref: '#/components/schemas/_fixedReference' + bucket_type: + description: | + The bucket type for the bucket. + type: string + readOnly: true + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + destroyed: + description: | + Is the bucket destroyed? + type: boolean + eradication_config: + title: BucketEradicationConfig + allOf: + - $ref: '#/components/schemas/_bucketEradicationConfig' + hard_limit_enabled: + description: | + If set to `true`, the bucket's size, as defined by `quota_limit`, + is used as a hard limit quota. + If set to `false`, a hard limit quota will not be applied to the + bucket, but soft quota alerts will still be sent if the bucket has + a value set for `quota_limit`. + type: boolean + object_count: + description: The count of objects within the bucket. + type: integer + format: int64 + readOnly: true + object_lock_config: + $ref: '#/components/schemas/_objectLockConfigResponse' + public_access_config: + $ref: '#/components/schemas/_publicAccessConfig' + public_status: + description: | + Bucket's public status. Valid values include `bucket-and-objects-not-public`, + `only-authorized-users-of-this-account` and `public`. + type: string + readOnly: true + example: bucket-and-objects-not-public + qos_policy: + description: | + The QoS policy for the bucket defines the performance controls + that can be applied to the aggregate performance of all the clients + accessing the bucket. + If no policy is configured for a bucket, then no performance + controls are applied to it. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + quota_limit: + description: | + The effective quota limit applied against the size of the bucket, displayed in bytes. + If unset, the bucket is unlimited in size. + type: integer + retention_lock: + description: | + If set to `ratcheted`, then `object_lock_config.default_retention_mode` + cannot be changed if set to `compliance`. In this case, the value of + `object_lock_config.default_retention` can only be increased and + `object_lock_config.default_retention_mode` cannot be changed once set + to `compliance`. + Valid values are `unlocked` and `ratcheted`. + Contact Pure Technical Services to change `ratcheted` to `unlocked`. + type: string + example: unlocked + space: + description: The space specification of the bucket. + title: Space + allOf: + - $ref: '#/components/schemas/_space' + storage_class: + $ref: '#/components/schemas/StorageClassInfo' + time_remaining: + description: | + Time in milliseconds before the bucket is eradicated. + `null` if not destroyed or legal hold was found or the remaining time + until eradication is not known yet. + type: integer + format: int64 + readOnly: true + time_remaining_status: + description: | + Status of the `time_remaining` field. + `calculating` means the bucket is `retention-based`, has been destroyed and the + `time_remaining` is being calculated by a background process + `legal-hold` means the bucket is `retention-based`, has been destroyed and will never be + eradicated, because an object with legal hold status was found inside. + null otherwise, i.e. when either the bucket is not destroyed or it's destroyed and the + `time_remaining` has been determined. + type: string + readOnly: true + example: calculating + versioning: + description: | + The versioning state for objects within the bucket. + Valid values are `none`, `enabled`, and `suspended`. + type: string + BucketAuditFilterBase: + type: object + properties: + actions: + description: | + The list of ops to be audited by this filter. + type: array + items: + type: string + example: + - s3:GetObject + - s3:READ_OPS + - s3:WRITE_OPS + s3_prefixes: + description: | + The list of object name prefixes. The corresponding ops present in this filter will be audited + for the objects having these prefixes. + type: array + items: + type: string + example: + - prefix1 + - prefix2 + BucketAuditFilterWithContext: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/BucketAuditFilter' + CrossOriginResourceSharingPolicyRuleBulkManage: + allOf: + - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRulePost' + - type: object + properties: + name: + description: "Name of the object (e.g., a file system or snapshot)." + type: string + CrossOriginResourceSharingPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + bucket: + description: The bucket to which this policy belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + rules: + type: array + maxItems: 100 + items: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleWithContext' + CrossOriginResourceSharingPolicyRuleWithContext: + allOf: + - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRule' + - $ref: '#/components/schemas/_context' + BucketPerformanceItems: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + bytes_per_op: + description: | + Average operation size (read bytes+write bytes/read ops+write ops). + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + max_total_bytes_per_sec: + description: Limit on throughput in bytes per bucket. + type: number + format: double + minimum: 0 + readOnly: true + max_total_ops_per_sec: + description: Limit on operation count per bucket. + type: number + format: double + minimum: 0 + readOnly: true + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read request. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write request. + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + BucketPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + bytes_per_op: + description: | + Average operation size (read bytes+write bytes/read ops+write ops). + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read request. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write request. + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + BucketAccessPolicyRuleBulkManage: + allOf: + - $ref: '#/components/schemas/BucketAccessPolicyRulePost' + - type: object + properties: + name: + description: "Name of the object (e.g., a file system or snapshot)." + type: string + BucketAccessPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + bucket: + description: The bucket to which this policy belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + rules: + type: array + items: + $ref: '#/components/schemas/BucketAccessPolicyRule' + BucketAccessPolicyRulePrincipal: + type: object + properties: + all: + description: | + If `true`, the rule will apply to all object store users regardless of their + origin or principal. + type: boolean + BucketAccessPolicyRuleWithContext: + allOf: + - $ref: '#/components/schemas/BucketAccessPolicyRule' + - $ref: '#/components/schemas/_context' + BucketS3SpecificPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_buckets_per_sec: + description: Read buckets requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_objects_per_sec: + description: Read object requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_bucket_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read bucket request. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_object_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read object request. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_bucket_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write bucket request. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_object_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write object request. + type: number + format: double + minimum: 0 + readOnly: true + write_buckets_per_sec: + description: Write buckets requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + write_objects_per_sec: + description: Write object requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + _replicaLinkBuiltIn: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - type: object + properties: + direction: + $ref: '#/components/schemas/_direction' + 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 + status_details: + description: | + Detailed information about the status of the replica link when it is + unhealthy. + type: string + readOnly: true + _objectBacklog: + type: object + properties: + bytes_count: + description: | + The size of the objects in bytes that need to be replicated. + This does not include the size of custom metadata. + type: integer + format: int64 + readOnly: true + delete_ops_count: + description: | + The number of DELETE operations that need to be replicated. + type: integer + format: int64 + readOnly: true + other_ops_count: + description: | + The number of other operations that need to be replicated. + type: integer + format: int64 + readOnly: true + put_ops_count: + description: | + The number of PUT operations that need to be replicated. + type: integer + format: int64 + readOnly: true + _fixedReferenceNameOnly: + type: object + properties: + name: + type: string + readOnly: true + x-readOnly: true + _certificateBase: + allOf: + - type: object + properties: + certificate: + description: The text of the certificate. + type: string + certificate_type: + description: | + The type of certificate. Possible values are `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. + This field may only be specified at certificate creation time. + If not specified at creation time, defaults to `external`. + type: string + common_name: + description: The common name field listed in the certificate. + type: string + country: + description: The country field listed in the certificate. + type: string + example: Canada + email: + description: The email field listed in the certificate. + type: string + example: tcrisp@example.com + intermediate_certificate: + description: Intermediate certificate chains. + type: string + issued_by: + description: Who issued this certificate. + type: string + readOnly: true + example: Example Incorporated + issued_to: + description: Who this certificate was issued to. + 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 + realms: + description: | + The realms containing this certificate. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + 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: 1491070899000 + valid_to: + description: | + The date when the certificate stops being valid. + type: integer + format: int64 + readOnly: true + example: 152424849000 + Certificate: + allOf: + - description: SSL Certificate managed by Purity. + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_certificateBase' + Member: + type: object + properties: + group: + description: | + A reference to a group object that has the referenced member object + as a member. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + member: + description: | + A reference to an object that is a member of the referenced group. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + CertificateSigningRequest: + description: | + SSL certificate managed by Purity. + type: object + properties: + certificate_signing_request: + description: | + The text of a new certificate signing request. + type: string + CertificateUse: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + group: + description: | + A reference to a certificate group that is being used, if any, where + this certificate is a member of the certificate-group. This field is + `null` if the referenced use object is not using a group, but is rather + using this certificate directly. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + use: + description: A reference to an object using this certificate. + title: FixedReferenceWithRemote + allOf: + - $ref: '#/components/schemas/_fixedReferenceWithRemote' + CertificateGroup: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + realms: + description: | + The realms containing this certificate group. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + CertificateGroupUse: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + use: + description: A reference to an object using this certificate group. + title: FixedReferenceWithRemote + allOf: + - $ref: '#/components/schemas/_fixedReferenceWithRemote' + PolicyBase: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + PolicyBaseRenameable: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + enabled: + description: | + If `true`, the policy is enabled. If not specified, defaults to `true`. + type: boolean + is_local: + description: Whether the policy is defined on the local array. + type: boolean + readOnly: true + location: + description: Reference to the array where the policy is defined. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy_type: + description: | + Type of the policy. Valid values include `alert`, `audit`, `bucket-access`, + `cross-origin-resource-sharing`, `network-access`, `nfs`, `object-access`, + `s3-export`, smb-client`, `smb-share`, `ssh-certificate-authority`, and + `telemetry-metrics`. + type: string + readOnly: true + realms: + description: | + The realms containing this policy. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + _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 + 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 + _directoryServiceNfs: + description: Properties specific to the NFS service. + type: object + properties: + nis_domains: + description: NIS domains to search. + type: array + items: + type: string + example: ypdomain + nis_servers: + description: | + A list of the IP addresses or hostnames of NIS servers to search. + type: array + items: + type: string + example: 181.44.543.12 + _directoryServiceSmb: + description: DEPRECATED - Properties specific to the SMB service. + type: object + properties: + join_ou: + description: | + Optional organizational unit where the machine account for the directory service will be created. + type: string + example: OU=my_organizational_unit + TestResultWithContext: + allOf: + - $ref: '#/components/schemas/TestResult' + - $ref: '#/components/schemas/_context' + Drive: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + details: + description: | + Details about the status of the drive if not healthy. + type: string + readOnly: true + progress: + description: | + Reflects this drive's current progress toward completing a planned + evacuation. If a planned evacuation is not occurring, the value will + be `null`. + type: number + format: float + minimum: 0 + maximum: 1 + readOnly: true + raw_capacity: + type: integer + format: int64 + readOnly: true + status: + description: | + Current status of the drive. Valid values are `evacuated`, + `evacuating`, `healthy`, `unhealthy`, `unused`, and `updating`. + type: string + readOnly: true + type: + description: | + The type of the module. Valid values are `DFM` and `DFMe`. + type: string + readOnly: true + example: DFM + _fileSystemEradicationConfig: + description: Configuration settings related to file system eradication. + type: object + properties: + eradication_mode: + description: | + The eradication mode of the file system. + If it's `permission-based` the file system can be eradicated based + on user permissions. + If it's `retention-based` the file system can not be eradicated + until no files/inodes are locked or retained. + Valid values are `permission-based` and `retention-based`. + type: string + example: permission-based + manual_eradication: + description: | + The manual eradication status of the file system. + If `disabled`, the file system cannot be eradicated after it has been + destroyed, unless it is empty. + If `enabled`, the file system can be eradicated. + Valid values are `disabled` and `enabled`. + type: string + readOnly: true + example: enabled + _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/_reference' + - type: object + properties: + configuration: + description: | + The name of the preset configuration object. + type: string + _http: + type: object + properties: + enabled: + description: "Is the protocol enabled? If not specified, defaults to `false`." + type: boolean + _multiProtocolPost: + 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. + Defaults to `shared`. + 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`. + Defaults to `true`. + type: boolean + _nfs: + type: object + properties: + export_policy: + description: | + Deprecated. See File System Exports for newer functionality. + The value returned will be the `policy` of the File System + Export for the default server, and NFS, with the `export_name` + matching the file system name, if there is one and null otherwise. + Modifying this field will still work. + If the current value is null, then setting this field will attempt + to create a File System Export with the policy + and other default values. The `export_name` will be the same as the + file system's `name`. + If the current value is not null, then setting this field will change + the policy in the matching File System Export. + Either the `export_policy` or `rules` will control the + NFS export functionality for the file system. + If this is set, then the `rules` field will be cleared. + Both `export_policy` and `rules` can not be set in the same request. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + rules: + description: | + Deprecated. See File System Exports and NFS Export Policies for newer functionality. + Modifying this field will still work, causing the matching + File System Export to be deleted, if there is one. See `export_policy`. + Both `export_policy` and `rules` can not be set in the same request. + Rules can be applied to an individual + client or a range of clients specified by IP address (`ip_address(options)`), + netmask (`ip_address/length(options)`), netgroup (`@groupname(options)`), + hostname (`hostname(options)`) (see RFC-1123 part 2.1), fully qualified domain name + (`host.exampledomain.com(options)`) (see RFC-1123 part 2.1, RFC 2181 part 11), or wildcards + with fully qualified domain name or hostname (`*.exampledomain?.com(options)`). + Possible export options include `rw`, `ro`, `fileid_32bit`, `no_fileid_32bit`, + `anonuid`, `anongid`, `root_squash`, `no_root_squash`, `all_squash`, + `no_all_squash`, `secure`, `insecure`, `atime`, `noatime`, and `sec`. + If not specified, defaults to `*(rw,no_root_squash)`. + type: string + example: >- + 1.0.0.0/8(rw,no_root_squash) + fd01:abcd::/64(ro,secure,root_squash,anongid=16000) + @netgrp(rw,all_squash,anonuid=99,fileid_32bit) + 1.41.8.32(rw,no_all_squash,sec=krb5:krb5i:krp5p) + my-hostname(rw,no_root_squash) + host.exampledomain.com(rw,no_root_squash) + host?(rw,no_root_squash) + host?.example*domain.com(rw,no_root_squash) + host.*(rw,no_root_squash) + v3_enabled: + description: | + If set to `true`, the NFSv3 protocol will be enabled. + type: boolean + v4_1_enabled: + description: | + If set to `true`, the NFSv4.1 protocol will be enabled. + type: boolean + _smbPost: + allOf: + - $ref: '#/components/schemas/_smb' + - type: object + properties: + client_policy: + description: | + The SMB Client policy for the file system. Setting a policy here grants + access permissions (e.g. read-only or read-write) to the file system via + SMB on a per-client basis. + Defaults to a pre-defined full access policy if none is specified. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + share_policy: + description: | + The SMB Share policy for the file system. Setting a policy here + grants access permissions (e.g. allow or deny Full Control, Change, + and/or Read) to the file system via SMB on a per-user / per-group basis. + Defaults to a pre-defined full access policy if none is specified. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _workloadConfigurationReferencePatch: + type: object + description: | + Set the `id` or `name` of the workload to an empty string to remove the + resource from the workload. + allOf: + - $ref: '#/components/schemas/_reference' + _multiProtocol: + 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. + 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`. + type: boolean + _nfsPatch: + allOf: + - $ref: '#/components/schemas/_nfs' + - type: object + properties: + add_rules: + description: | + The rules which will be added to the existing NFS export rules for the + file system. If `export_policy` is in use and and this field is set, the operation + will fail. + type: string + after: + description: | + The `after` field can be used with `add_rules` or `remove_rules` or both. + If used with `add_rules`, then the `add_rules` string will be inserted after + the first occurrence of the `after` string. + If used with `remove_rules`, then remove the first occurrence of `remove_rules` + after the first occurrence of the `after` string. The `remove_rules` will be + processed before the `add_rules`. + type: string + remove_rules: + description: | + The rules which will be removed from the existing NFS export rules for the + file system. Only the first occurrence of the `remove_rules` will be removed. + If `export_policy` is in use and and this field is set, the operation will fail. + type: string + _smb: + type: object + properties: + client_policy: + description: | + Deprecated. See File System Exports for newer functionality. + The value returned will be the `client_policy` of the File System + Export for the default server, and SMB, with the `export_name` + matching the file system name, if there is one and null otherwise. + Modifying this field will still work. + If the current value is null, then setting this field will attempt + to create a File System Export with the `client_policy` + and other default values. The `export_name` will be the same as the + file system's `name`. + If the current value is not null, then setting this field will change + the `client_policy` in the matching File System Export. + The SMB Client policy for the file system. Setting a policy here grants + access permissions (e.g. read-only or read-write) to the file system via + SMB on a per-client basis. + If no policy is set here, no client will have access. + Use "" to clear. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + continuous_availability_enabled: + description: | + If set to `true`, the file system will be continuously available during + disruptive scenarios such as network disruption, blades failover, etc. + If not specified, defaults to `true`. + type: boolean + enabled: + description: | + If set to `true`, enables access to the file system over the SMB + protocol. If not specified, defaults to `false`. + type: boolean + share_policy: + description: | + Deprecated. See File System Exports for newer functionality. + The value returned will be the `policy` of the File System + Export for the default server, and SMB, with the `export_name` + matching the file system name, if there is one and null otherwise. + Modifying this field will still work. + If the current value is null, then setting this field will attempt + to create a File System Export with the policy + and other default values. The `export_name` will be the same as the + file system's `name`. + If the current value is not null, then setting this field will change + the `policy` in the matching File System Export. + The SMB Share policy for the file system. Setting a policy here + grants access permissions (e.g. allow or deny Full Control, Change, + and/or Read) to the file system via SMB on a per-user / per-group basis. + If no policy is set here, no user or group will have access. + Use "" to clear. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _fixedLocationReference: + allOf: + - $ref: '#/components/schemas/_fixedReference' + - type: object + properties: + display_name: + description: | + Full name of the source with remote array information. + Response will be same as source name for local file systems and policies. + type: string + readOnly: true + example: irp624-c02:fs1 + is_local: + description: | + Is the location reference to the local array or somewhere remote? + type: boolean + readOnly: true + location: + description: | + A reference to the location where the object is defined. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + FileSystem: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + created: + description: Creation timestamp of the file system. + type: integer + format: int64 + readOnly: true + default_group_quota: + description: The default space quota for a group writing to this file system. + type: integer + format: int64 + default_user_quota: + description: The default space quota for a user writing to this file system. + type: integer + format: int64 + destroyed: + description: | + Returns a value of `true` if the file system has been destroyed and is pending eradication. + The file system cannot be modified while it is in the destroyed state. + The `time_remaining` value displays the amount of time left until the destroyed + file system is permanently eradicated. Once eradication has begun, the file system can no + longer be recovered. Before the `time_remaining` period has elapsed, + the destroyed file system can be recovered through the PATCH method + by setting `destroyed=false`. + type: boolean + eradication_config: + $ref: '#/components/schemas/_fileSystemEradicationConfig' + fast_remove_directory_enabled: + description: | + If set to `true`, the file system, when mounted, will contain a + directory that can be used for fast removal of other directories. + Directories can be moved into the fast remove directory in order + to have them deleted, and their space freed, more quickly than a + normal removal operation. + type: boolean + group_ownership: + description: | + The group ownership for new files and directories in a file system. + Possible values are `creator` and `parent-directory`. + If `creator` is selected, the owning group of new files and directories + is the primary group of the user who creates them. + If `parent-directory` is selected, the owning group is the parent + directory group. + Note: Existing files and directories are unaffected by this change. + type: string + hard_limit_enabled: + description: | + If set to `true`, the file system's size, as defined by `provisioned`, + is used as a hard limit quota. + type: boolean + http: + description: HTTP configuration. + title: Http + allOf: + - $ref: '#/components/schemas/_http' + multi_protocol: + description: Multi-protocol configuration. + title: MultiProtocol + allOf: + - $ref: '#/components/schemas/_multiProtocol' + nfs: + description: NFS configuration. + title: Nfs + allOf: + - $ref: '#/components/schemas/_nfs' + node_group: + description: | + The nodes contains the data of the file system. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + promotion_status: + description: | + Possible values are `promoted` and `demoted`. + The current status of the file system with respect to replication. Changes via + `requested_promotion_state`. The default for new file systems is + `promoted`. + type: string + readOnly: true + provisioned: + description: | + The provisioned size of the file system, displayed in bytes. If set to an + empty string (`""`), the file system is unlimited in size. + type: integer + format: int64 + example: 1048576 + qos_policy: + description: | + The QoS policy for the File System defines the performance controls + that can be applied to the aggregate performance of all the clients + accessing the file system. + If no policy is configured for a file system, then no performance + controls are applied to it. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + realms: + description: | + The realms containing this file system. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + requested_promotion_state: + description: | + Possible values are `promoted` and `demoted`. + The `demoted` state is used for replication targets and is only allowed to be set + if the file system is in a replica-link relationship. The additional + query param `discard-non-snapshotted-data` must be set to `true` + when demoting a file system. The default for new file systems is + `promoted`. + type: string + smb: + description: SMB configuration. + title: Smb + allOf: + - $ref: '#/components/schemas/_smb' + snapshot_directory_enabled: + description: | + If set to `true`, a hidden .snapshot directory will be present in each + directory of the file system when it is mounted. + The .snapshot directory allows clients read access to the contents of + the snapshots that have been taken of a directory. + If set to `false`, the .snapshot directory will not be present in any + directories within a mounted file system. + type: boolean + source: + description: A reference to the source file system. + title: LocationReference + allOf: + - $ref: '#/components/schemas/_locationReference' + space: + description: The space usage of the file system. + title: Space + allOf: + - $ref: '#/components/schemas/_space' + storage_class: + $ref: '#/components/schemas/StorageClassInfo' + time_remaining: + description: | + Time in milliseconds before the file system is eradicated. + `null` if not destroyed. + type: integer + format: int64 + readOnly: true + workload: + $ref: '#/components/schemas/_workloadConfigurationReference' + writable: + description: | + Whether the file system is writable or not. If `false`, this overrides + any protocol or file permission settings and prevents changes. If `true`, then + the protocol and file permission settings are evaluated. + If not specified, defaults to `true`. Modifiable. + type: boolean + FileSystemGroupPerformance: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + bytes_per_op: + description: | + Average operation size (read bytes+write bytes/read ops+write ops). + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + file_system: + description: The file system on which the performance was measured. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + group: + description: The group whose performance is represented. + title: Group + allOf: + - $ref: '#/components/schemas/_group' + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read request. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write request. + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + FileSystemPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + bytes_per_op: + description: | + Average operation size (read bytes+write bytes/read ops+write ops). + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read request. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write request. + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + FileSystemUserPerformance: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + bytes_per_op: + description: | + Average operation size (read bytes+write bytes/read ops+write ops). + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + file_system: + description: The file system on which the performance was measured. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: | + Average time, measured in microseconds, it takes the array to process + other operations. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: | + Average time, measured in microseconds, it takes the array to process + a read request. + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: | + Average time, measured in microseconds, it takes the array to process + a write request. + type: number + format: double + minimum: 0 + readOnly: true + user: + description: The user whose performance is represented. + title: User + allOf: + - $ref: '#/components/schemas/_user' + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + WormDataPoliciesMembersResponse: + type: object + properties: + items: + description: A list of members for worm data policies. + type: array + items: + $ref: '#/components/schemas/PolicyMemberContext' + _fileSystemExportBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + enabled: + description: | + Returns a value of `true` if and only if the export policy that manages this + export is enabled AND the protocol is enabled on the file system. + type: boolean + readOnly: true + export_name: + description: | + The name of the export used by clients to mount the file system. + Export names must be unique within the same protocol/server combination. + type: string + member: + description: Reference to the file system the policy is applied to. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy: + description: Reference to the NFS export policy or SMB client policy. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + policy_type: + description: | + Policy type attached to the export. It is either SMB or NFS. + type: string + readOnly: true + server: + description: Reference to the server the export will be visible on. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + share_policy: + description: Reference to the SMB share policy (only used for SMB). + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + status: + description: | + Explains why `enabled` is `false`. Valid values include `policy_disabled` + and `protocol_disabled`. + type: string + readOnly: true + FileSystemExport: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_fileSystemExportBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + workload: + $ref: '#/components/schemas/_workloadConfigurationFixedReference' + _fixedReferenceNoResourceType: + type: object + properties: + id: + description: | + A non-modifiable, globally unique ID chosen by the system. + type: string + readOnly: true + name: + type: string + readOnly: true + x-readOnly: true + _locationReference: + allOf: + - $ref: '#/components/schemas/_reference' + - type: object + properties: + display_name: + description: | + Full name of the source with remote array information. + Response will be same as source name for local file systems and policies. + type: string + readOnly: true + example: irp624-c02:fs1 + is_local: + description: | + Is the location reference to the local array or somewhere remote? + type: boolean + readOnly: true + location: + description: | + A reference to the location where the object is defined. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + PolicyMemberWithRemote: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/PolicyFileSystemSnapshot' + - type: object + properties: + link: + description: | + Only populated if the `member` is a file system replica link. Contains additional + information about the link. + title: MemberLink + allOf: + - $ref: '#/components/schemas/_memberLink' + FileSystemSnapshotTransferResponse: + type: object + properties: + items: + description: A list of file system snapshot objects. + type: array + items: + $ref: '#/components/schemas/FileSystemSnapshotTransfer' + FileSystemSnapshotTransfer: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + completed: + description: | + A timestamp at which the replication of the snapshot completed. + type: integer + format: int64 + readOnly: true + data_transferred: + description: "The amount of data transferred to the target, in bytes." + type: integer + format: int64 + readOnly: true + direction: + $ref: '#/components/schemas/_direction' + local_snapshot: + description: | + A reference to the associated local file system snapshot. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + progress: + description: | + A percentage that indicates + how much progress has been made on the transfer. + type: number + format: double + minimum: 0 + maximum: 1 + readOnly: true + remote: + description: | + The array where the remote file system snapshot is located. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + remote_snapshot: + description: | + A reference to the associated remote file system snapshot. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + started: + description: | + A timestamp at which the replication of the snapshot started. + type: integer + format: int64 + readOnly: true + status: + description: | + The status of current replication. + Valid values are `completed`, `in-progress`, and `queued`. + type: string + readOnly: true + PolicyFileSystemSnapshotResponse: + type: object + properties: + items: + description: A list of members for policies. + type: array + items: + $ref: '#/components/schemas/PolicyFileSystemSnapshot' + FileLockResponse: + type: object + properties: + items: + description: A list of file locks. + type: array + items: + $ref: '#/components/schemas/FileLock' + FileSystemClientsResponse: + type: object + properties: + items: + description: A list of file system clients. + type: array + items: + $ref: '#/components/schemas/FileSystemClient' + FileSystemLockNlmReclamation: + 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 + FileSessionResponse: + type: object + properties: + items: + description: A list of file sessions. + type: array + items: + $ref: '#/components/schemas/FileSession' + FileSystemStorageClassSpace: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + space: + $ref: '#/components/schemas/_space' + storage_class: + description: The storage class type of the space information, either `S500X-S` (speed) or + `S500X-A` (archival). + type: string + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + FileSystemOpenFilesResponse: + type: object + properties: + items: + description: A list of file system open file objects. + type: array + items: + $ref: '#/components/schemas/FileSystemOpenFile' + _newName: + type: object + properties: + name: + description: The new name for the resource. + type: string + 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/_fleetMemberPostMembersMember' + FleetMember: + type: object + properties: + coordinator_of: + description: | + List of array groups that the member is the coordinator of. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + fleet: + $ref: '#/components/schemas/_fixedReferenceWithIsLocal' + member: + $ref: '#/components/schemas/_fixedReferenceWithIsLocal' + 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 + HardwareTemperatures: + description: | + Provides detailed information about temperature readings from a sensor, + including its status and threshold limits. + type: object + properties: + name: + description: The name of the temperature sensor. + type: string + readOnly: true + reading: + description: The latest temperature measurement reported by the sensor. + type: number + format: double + readOnly: true + status: + description: | + The current operational state of the sensor, + indicating whether it is functioning normally or experiencing issues. + Possible values include HEALTHY, NON_CRITICAL, CRITICAL, UNRECOVERABLE, UNKNOWN. + type: string + readOnly: true + thresholds: + $ref: '#/components/schemas/HardwareTemperaturesThresholds' + HardwareConnectorPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + link_aggregation_group: + description: The link aggregation group which this entity belongs to. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + other_errors_per_sec: + description: | + The sum of unspecified reception and transmission errors per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + received_bytes_per_sec: + description: | + Bytes received per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + received_crc_errors_per_sec: + description: | + Reception CRC errors per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + received_frame_errors_per_sec: + description: | + Received packet frame errors per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + received_packets_per_sec: + description: | + Packets received per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + time: + description: | + Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + total_errors_per_sec: + description: | + The sum of all reception and transmission errors per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + transmitted_bytes_per_sec: + description: | + Bytes transmitted per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + transmitted_carrier_errors_per_sec: + description: | + Transmission carrier errors per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + transmitted_dropped_errors_per_sec: + description: | + Transmitted packets dropped per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + transmitted_packets_per_sec: + description: | + Packets transmitted per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + x-readOnly: true + Keytab: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + encryption_type: + description: | + The encryption type used by the Kerberos key distribution center to + generate the keytab. + type: string + readOnly: true + example: aes256-cts-hmac-sha1-96 + fqdn: + description: | + The fully qualified domain name to which the keytab was issued. + type: string + readOnly: true + example: vip1.my-array.customerdomain.example.com + kvno: + description: | + The key version number of the key used to generate the keytab. + type: integer + format: int64 + readOnly: true + example: 1 + prefix: + description: | + The prefix in the name of the keytab object. This is the same for + all keytab objects created from a single keytab file. The name of + a keytab entry is created in the format `.` for all + entries. + type: string + readOnly: true + example: auth-keytabs + principal: + description: The service name for which the keytab was issued. + type: string + readOnly: true + example: nfs + realm: + description: The Kerberos realm that issued the keytab. + type: string + readOnly: true + example: my-secure-realm.com + server: + description: | + The server where the keytab is used. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + source: + description: | + A reference to the Active Directory configuration for the computer account + that was used to create this keytab. If this keytab was uploaded from a + file, all fields in the reference possess `null` values. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + suffix: + description: | + The suffix in the name of the keytab object, determined at creation + time using the slot number of the keytab entry in a file and the + number of existing entries with the same prefix. The name of a + keytab entry is created in the format `.` for all + entries. + type: integer + format: int64 + readOnly: true + example: 4 + LegalHoldHeldEntity: + type: object + properties: + file_system: + description: Reference to the file system that the legal hold is applied to. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + legal_hold: + description: Reference to the legal hold. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + path: + description: The path of the file or directory being held. + type: string + status: + description: | + The status of the legal hold with respect to the held entity. + Valid values include: + `applied` for holds that are actively applied, + `applying` for holds that are being recursively applied but have not yet completed, + `releasing` for holds that are being released recursively but have not yet completed. + Entities that are releasing will no longer be held once this operation completes. + type: string + _lifecycleRuleConfigExtension: + 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 + LifecycleRule: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/_lifecycleRuleConfigExtension' + - type: object + properties: + bucket: + description: | + The bucket which this lifecycle rule is targeting. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + 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 + keep_previous_version_for: + description: | + Time after which previous 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 + prefix: + description: | + Object key prefix identifying one or more objects in the bucket. + Can have a maximum length of 1024 characters. + type: string + rule_id: + description: | + Unique identifier for the rule. + Can have a maximum length of 255 characters. + type: string + FileInfo: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + length: + description: | + Length of the file (in bytes). + type: integer + readOnly: true + _auditLogNamePrefix: + type: object + properties: + prefix: + description: | + Prefix for the audit log object name. + type: string + example: s3auditlog + _auditLogRotate: + type: object + properties: + duration: + description: | + Time after which audit log objects will be rotated. + Measured in milliseconds. + Multiples of 60000 are supported. + type: integer + format: int64 + minimum: 300000 + maximum: 86400000 + example: 300000 + LogTargetsObjectStoreWithContext: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/LogTargetsObjectStore' + MaintenanceWindow: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: | + The period of time during which maintenance occurs. + Many 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 + ManagementAccessPolicyRuleInPolicy: + allOf: + - $ref: '#/components/schemas/ManagementAccessPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + _version: + type: object + properties: + version: + description: | + A hash of the other properties of this resource. This can be used when + updating the resource to ensure there aren't any updates since the + resource was read. + type: string + readOnly: true + ManagementAuthenticationPolicyConfig: + allOf: + - type: object + description: | + The authentication configuration for a specific interface (e.g., ssh). Two types of + configurations are supported: `allowed_methods` and `required_methods`, but only one of them can + be set to a non-empty list. + If `allowed_methods` is set, admins can authenticate using any of the methods in the list via + the interface. + If `required_methods` is set, admins must authenticate using all of the methods in the list via + the interface. + properties: + allowed_methods: + description: | + The authentication methods that are allowed for this interface. It cannot contain + duplicates. + type: array + maxItems: 10 + items: + $ref: '#/components/schemas/ManagementAuthenticationPolicyConfigMethod' + required_methods: + description: | + The authentication methods that are required for this interface. It cannot contain + duplicates. `default` is not allowed as a required method. + type: array + maxItems: 10 + items: + $ref: '#/components/schemas/ManagementAuthenticationPolicyConfigMethod' + PolicyBaseContext: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + NetworkAccessPolicyRuleInPolicy: + allOf: + - $ref: '#/components/schemas/NetworkAccessPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + NetworkAccessPolicyRulePostBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + client: + description: | + Specifies the clients that will be permitted or denied access to the interface. + Accepted notations include a single IP address, subnet in CIDR notation, + or all clients (specified as `*`). + The default value is `*` if not specified. + type: string + example: 1.2.3.4 + effect: + description: | + If set to `allow`, the specified client will be permitted to access the specified + interfaces. If set to `deny`, the specified client will be denied access to them. + Valid values include `allow` and `deny`. + The default value is `allow` if not specified. + type: string + interfaces: + description: | + Specifies which product interfaces this rule applies to, whether it is + permitting or denying access. Valid values include `management-ssh`, + `management-rest-api`, `management-web-ui`, `snmp`, and + `local-network-superuser-password-access`. + type: array + maxItems: 5 + items: + type: string + _policyRuleIndex: + type: object + properties: + index: + description: | + The index within the policy. The `index` indicates the order the rules are evaluated. + NOTE: It is recommended to use the query param `before_rule_id` to do reordering to + avoid concurrency issues, but changing `index` is also supported. `index` can not be + changed if `before_rule_id` or `before_rule_name` are specified. + type: integer + format: int32 + NetworkAccessPolicyRuleBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + client: + description: | + Specifies the clients that will be permitted or denied access to the interface. + Accepted notations include a single IP address, subnet in CIDR notation, + or all clients (specified as `*`). + The default value is `*` if not specified. + type: string + example: 1.2.3.4 + effect: + description: | + If set to `allow`, the specified client will be permitted to access the specified + interfaces. If set to `deny`, the specified client will be denied access to them. + Valid values include `allow` and `deny`. + type: string + interfaces: + description: | + Specifies which product interfaces this rule applies to, whether it is + permitting or denying access. Valid values include `management-ssh`, + `management-rest-api`, `management-web-ui`, `snmp`, and + `local-network-superuser-password-access`. + type: array + maxItems: 5 + items: + type: string + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy_version: + description: | + The policy's version. This can be used when updating the + resource to ensure there aren't any updates to the policy since the resource was read. + type: string + readOnly: true + _referenceWithoutType: + type: object + properties: + id: + description: | + A globally unique, system-generated ID. + The ID cannot be modified. + type: string + name: + description: | + The resource name, such as volume name, pod name, + snapshot name, and so on. + type: string + NetworkInterfacePingResponse: + type: object + properties: + items: + description: A list of network ping run result. + type: array + items: + $ref: '#/components/schemas/NetworkInterfacePing' + NetworkInterfaceTraceResponse: + type: object + properties: + items: + description: A list of network trace run result. + type: array + items: + $ref: '#/components/schemas/NetworkInterfaceTrace' + NetworkInterfacesConnectorsPerformance: + allOf: + - $ref: '#/components/schemas/HardwareConnectorPerformance' + - 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 + readOnly: true + flow_control_received_discarded_packets_per_sec: + description: | + Number of received packets that were physically discarded + per second due to errors or other reasons. + type: integer + format: int64 + minimum: 0 + readOnly: true + flow_control_received_lossless_bytes_per_sec: + description: | + Bytes received per second with lossless flow control settings. + type: integer + format: int64 + minimum: 0 + readOnly: true + flow_control_received_pause_frames_per_sec: + description: | + Received pause frames per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + flow_control_transmitted_congestion_packets_per_sec: + description: | + Number of congestion control packets transmitted per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + 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 + readOnly: true + flow_control_transmitted_lossless_bytes_per_sec: + description: | + Bytes transmitted per second with lossless flow control settings. + type: integer + format: int64 + minimum: 0 + readOnly: true + flow_control_transmitted_pause_frames_per_sec: + description: | + Transmitted pause frames per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + 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 + readOnly: true + rdma_received_sequence_errors_per_sec: + description: | + The number of received RDMA packet sequence errors per second. + type: integer + format: int64 + minimum: 0 + readOnly: true + 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 + readOnly: true + x-readOnly: true + NetworkInterfacesConnectorsSetting: + description: The global network setting for all network connectors. + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + roce: + description: | + RoCE(RDMA over Converged Ethernet) configuration for network connectors. + title: NetworkInterfacesConnectorsSettingRoce + allOf: + - $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingRoce' + NetworkConnectionStatisticsResponse: + type: object + properties: + items: + description: | + A list of network connection statistics + type: array + items: + $ref: '#/components/schemas/NetworkConnectionStatistics' + NetworkInterfaceNeighborResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/NetworkInterfaceNeighbor' + description: | + A list of network LLDP neighbors + NfsExportPolicyRuleInPolicy: + allOf: + - $ref: '#/components/schemas/NfsExportPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + NfsExportPolicyPatchRuleInPolicy: + allOf: + - $ref: '#/components/schemas/NfsExportPolicyRuleBasePatchRequest' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + NfsExportPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - $ref: '#/components/schemas/_context' + - type: object + properties: + rules: + description: | + All of the rules that are part of this policy. The order is the evaluation order. + type: array + items: + $ref: '#/components/schemas/NfsExportPolicyRuleInPolicy' + workload: + $ref: '#/components/schemas/_workloadConfigurationFixedReference' + NfsExportPolicyRuleBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + access: + description: | + Specifies access control for the export. Valid values are `root-squash`, `all-squash`, and + `no-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-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 + 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. + type: integer + format: int64 + minimum: 0 + 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: integer + format: int64 + minimum: 0 + example: 65530 + atime: + description: | + If `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 `false`, disables the update of inode access times after read operations. + Defaults to `true`. + type: boolean + 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. + type: string + fileid_32bit: + description: | + Whether the file id is 32 bits or not. Defaults to `false`. + type: boolean + 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. + type: string + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy_version: + description: | + The policy's version. This can be used when updating the + resource to ensure there aren't any updates to the policy since the resource was read. + type: string + readOnly: true + required_transport_security: + description: | + Specifies the minimum transport security required for clients to access the export. + If `tls` is set, then all clients must use TLS or their attempts to mount will be rejected, + and further use of client certificate authentication is optional. + If `mutual-tls` is set, then all clients must use TLS with client certificate authentication + or their attempts to mount will be rejected. + If `none`, then no specific transport security mechanism is required and any transport + security mechanisms are permitted for use. + If not specified when a rule is created, defaults to `none`. + type: string + example: tls + secure: + description: | + If `true`, prevents NFS access to client connections coming from non-reserved ports. Applies + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + If `false`, allows NFS access to client connections coming from non-reserved ports. Applies + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + The default is `false` if not specified. + type: boolean + security: + description: | + The security flavors to use for accessing files on this mount point. If the server does not + support the requested flavor, the mount operation fails. + If `sys`, trusts the client to specify user's identity. + If `krb5`, provides cryptographic proof of a user's identity 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 in order to + enable Kerberos security. + If `krb5i`, adds integrity checking to krb5, to ensure the data has not been tampered with. + If `krb5p`, adds integrity checking and encryption to krb5. This is the most secure setting, + but it also involves the most performance overhead. + The default is `sys` if not specified. + type: array + items: + type: string + example: sys + NfsExportPolicyRuleBasePatchRequest: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + access: + description: | + Specifies access control for the export. Valid values are `root-squash`, `all-squash`, and + `no-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-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 + 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. + 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" + atime: + description: | + If `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 `false`, disables the update of inode access times after read operations. + Defaults to `true`. + type: boolean + 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. + type: string + fileid_32bit: + description: | + Whether the file id is 32 bits or not. Defaults to `false`. + type: boolean + 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. + type: string + required_transport_security: + description: | + Specifies the minimum transport security required for clients to access the export. + If `tls` is set, then all clients must use TLS or their attempts to mount will be rejected, + and further use of client certificate authentication is optional. + If `mutual-tls` is set, then all clients must use TLS with client certificate authentication + or their attempts to mount will be rejected. + If `none`, then no specific transport security mechanism is required and any transport + security mechanisms are permitted for use. + If not specified when a rule is created, defaults to `none`. + type: string + example: tls + secure: + description: | + If `true`, prevents NFS access to client connections coming from non-reserved ports. Applies + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + If `false`, allows NFS access to client connections coming from non-reserved ports. Applies + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + The default is `false` if not specified. + type: boolean + security: + description: | + The security flavors to use for accessing files on this mount point. If the server does not + support the requested flavor, the mount operation fails. + If `sys`, trusts the client to specify user's identity. + If `krb5`, provides cryptographic proof of a user's identity 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 in order to + enable Kerberos security. + If `krb5i`, adds integrity checking to krb5, to ensure the data has not been tampered with. + If `krb5p`, adds integrity checking and encryption to krb5. This is the most secure setting, + but it also involves the most performance overhead. + The default is `sys` if not specified. + type: array + items: + type: string + example: sys + _referenceNameOnly: + type: object + properties: + name: + type: string + NodeGroup: + allOf: + - $ref: '#/components/schemas/_builtIn' + NodeGroupUse: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + use: + description: A reference to an object using this node group. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + _builtInNoId: + type: object + properties: + name: + description: "Name of the object (e.g., a file system or snapshot)." + type: string + readOnly: true + PolicyRuleObjectAccessBulkManage: + allOf: + - $ref: '#/components/schemas/PolicyRuleObjectAccessPost' + - type: object + properties: + name: + description: "Name of the object (e.g., a file system or snapshot)." + type: string + ObjectStoreAccessPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + account: + description: | + Reference of the associated account. If the policy is not associated + with an account, all fields in the reference possess `null` values. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + arn: + description: | + Amazon Resource Name of the policy. Used when referencing the policy via + S3 APIs. + type: string + readOnly: true + example: arn:aws:iam::myaccount:policy/mypolicy + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + description: + description: | + A description of the policy, optionally specified when the policy is + created. Cannot be modified for an existing policy. + type: string + readOnly: true + example: This policy allows users to list objects in production buckets. + enabled: + description: | + If `true`, the policy is enabled. If not specified, defaults to `true`. + type: boolean + readOnly: true + rules: + type: array + items: + $ref: '#/components/schemas/PolicyRuleObjectAccess' + updated: + description: The last updated timestamp of the object. + type: integer + format: int64 + readOnly: true + _policyRuleObjectAccessCondition: + type: object + properties: + s3_delimiters: + description: | + If specified, groups result objects by the specified delimiter. Only + top-level groupings will be returned. + Can be used with the `s3:ListBucket` and `s3:ListBucketVersions` actions. + type: array + items: + type: string + example: / + s3_prefixes: + description: | + If specified, restricts access and results based on the prefix of the + relevant objects. + Can be used with the `s3:ListBucket` and `s3:ListBucketVersions` actions. + type: array + items: + type: string + example: home/ + source_ips: + description: | + If specified, the rule will apply only to requests matching at least one + provided IP address or subnet. + Each entry must be in standard CIDR format (including an IP address + without an associated routing prefix). + Can be used with any action. + type: array + items: + type: string + example: + - 1.2.3.4 + - 5.6.7.0/24 + - 2001:DB8:1234:5678::/64 + PolicyRuleObjectAccess: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + actions: + description: | + The list of actions granted by this rule. Each included action may + restrict other properties of the rule. + Supported actions are returned by the + `/object-store-access-policy-actions` endpoint. + type: array + items: + type: string + example: + - s3:CreateBucket + - s3:PutObject + conditions: + description: | + Conditions used to limit the scope which this rule applies to. + title: PolicyRuleObjectAccessCondition + allOf: + - $ref: '#/components/schemas/_policyRuleObjectAccessCondition' + 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: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + 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* + ObjectStoreAccessPolicyActionResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ObjectStoreAccessPolicyAction' + _bucketDefaults: + type: object + properties: + hard_limit_enabled: + description: | + The value of this field will be used to configure the `hard_limit_enabled` + field of newly created buckets associated with this object store account, + if the bucket creation does not specify its own value. If not specified, + defaults to `false`. + type: boolean + quota_limit: + description: | + The value of this field will be used to configure the `quota_limit` field + of newly created buckets associated with this object store account, if the + bucket creation does not specify its own value. If set to an empty string + (`""`), the bucket default is unlimited in size. If not specified, + defaults to unlimited. + type: string + _serverForAccountExport: + type: object + properties: + server: + description: | + The server to which the account will be exported. + title: ReferenceWithoutType + allOf: + - $ref: '#/components/schemas/_referenceWithoutType' + ObjectStoreAccount: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + bucket_defaults: + description: | + Default settings to be applied to newly created buckets associated with + this account. Values here will be used in bucket creation requests which + do not specify their own values for corresponding fields. + title: BucketDefaultsReadonly + allOf: + - $ref: '#/components/schemas/_bucketDefaultsReadonly' + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + hard_limit_enabled: + description: | + If set to `true`, the account's size, as defined by `quota_limit`, + is used as a hard limit quota. + If set to `false`, a hard limit quota will not be applied to the + account, but soft quota alerts will still be sent if the account has + a value set for `quota_limit`. + type: boolean + object_count: + description: The count of objects within the account. + type: integer + format: int64 + readOnly: true + public_access_config: + $ref: '#/components/schemas/_publicAccessConfig' + quota_limit: + description: | + The effective quota limit applied against the size of the account, displayed in bytes. + If unset, the account is unlimited in size. + type: integer + realms: + description: | + The realms containing this account. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + space: + description: The space specification of the object store account. + title: Space + allOf: + - $ref: '#/components/schemas/_space' + ObjectStoreAccountExport: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + enabled: + description: | + Returns a value of `true` if the account export is enabled. + If not specified, defauts to `true`. + type: boolean + example: true + member: + description: | + References the account which will be exported. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy: + description: | + References the s3 export policy that is used for the export. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + realms: + description: | + A list of realms containing the export. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + server: + description: | + The server to which the account will be exported. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + ObjectStoreTrustPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + enabled: + description: | + If `true`, the policy is enabled. If not specified, defaults to `true`. + type: boolean + readOnly: true + role: + description: Object Store Role to which the Trust Policy applies. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + rules: + description: List of rules establishing the trust policy + type: array + items: + $ref: '#/components/schemas/TrustPolicyRule' + _trustPolicyRuleCondition: + description: | + Identity-provider-specific condition that specifies who can assume the role. + type: object + properties: + key: + description: | + Key from the context of the role assuming request that will have its + value compared based on the operator specified in this condition to the + values provided in this condition. + type: string + example: saml:sub + operator: + description: | + Operator specifying the comparison to be done between the values from + the request context and the values provided in this condition. + Valid values: `StringEquals`. + type: string + example: StringEquals + values: + description: | + Values to be compared with the values in the role assuming request + context identified by the key. If multiple values are specified, it's + sufficient if just one matches. + type: array + items: + type: string + example: + - something + - anything + TrustPolicyRuleWithContext: + allOf: + - $ref: '#/components/schemas/TrustPolicyRule' + - $ref: '#/components/schemas/_context' + ObjectStoreUser: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + access_keys: + description: References of the user's access keys. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + account: + description: Reference of the associated account. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + _policy_rule: + description: Rule + type: object + properties: + at: + description: | + Time during the day to take the snapshot (using array time zone), + only valid if 'every' is in days. + type: integer + format: int64 + every: + description: How often to take snapshots. + type: integer + format: int64 + keep_for: + description: The time to keep the snapshots for. + type: integer + format: int64 + time_zone: + description: The time zone to use with the `at` time. + type: string + example: America/Los_Angeles + SnapshotWormDataPolicyBase: + allOf: + - $ref: '#/components/schemas/_resourceFixed' + - $ref: '#/components/schemas/_realmsReference' + - type: object + properties: + enabled: + description: | + If `true`, the policy is enabled. If not specified, defaults to `true`. + type: boolean + is_local: + description: Whether the policy is defined on the local array. + type: boolean + readOnly: true + location: + description: Reference to the array where the policy is defined. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy_type: + description: | + Type of the policy. Valid values include `snapshot` and `worm-data`. + type: string + readOnly: true + Policy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + retention_lock: + description: | + If retention lock is locked, then the the policy can not be removed + from the associated file systems and the rules may not be changed. + Valid values are `locked` and `unlocked`. + Contact Pure Technical Services to change `locked` to `unlocked`. + type: string + readOnly: true + rules: + type: array + items: + $ref: '#/components/schemas/_policy_rule' + workload: + $ref: '#/components/schemas/_workloadConfigurationFixedReference' + PolicyBaseResponse: + type: object + properties: + items: + description: A list of basic policy objects. + type: array + items: + $ref: '#/components/schemas/PolicyBaseContext' + PublicKey: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/PublicKeyPost' + - type: object + properties: + algorithm: + description: | + The cryptographic algorithm used by the key. + Valid values include `rsa`, `rsassa-pss`, `dsa`, `ec`, and `ed25519`. + type: string + readOnly: true + example: rsa + key_size: + description: The size of the public key in bits. + type: integer + format: int32 + readOnly: true + example: 2048 + PublicKeyUseResponse: + type: object + properties: + items: + description: A list of public key use objects. + type: array + items: + $ref: '#/components/schemas/PublicKeyUse' + GroupQuota: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + file_system: + $ref: '#/components/schemas/_fixedReference' + file_system_default_quota: + description: | + File system's default group quota (in bytes). If it is `0`, it means + there is no default quota. This will be the effective group quota if + the group doesn't have an individual quota. This default quota is set + through the `file-systems` endpoint. + type: integer + format: int64 + readOnly: true + group: + description: The group on which this quota is enforced. + title: Group + allOf: + - $ref: '#/components/schemas/_group' + quota: + description: | + The space limit of the quota (in bytes) for the specified group, cannot + be `0`. If specified, this value will override the file system's default + group quota. + type: integer + format: int64 + usage: + description: | + The usage of the file system (in bytes) by the specified group. + type: integer + format: int64 + readOnly: true + UserQuota: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + file_system: + $ref: '#/components/schemas/_fixedReference' + file_system_default_quota: + description: | + File system's default user quota (in bytes). If it is `0`, it means there + is no default quota. This will be the effective user quota if the user + doesn't have an individual quota. This default quota is set through the + `file-systems` endpoint. + type: integer + format: int64 + readOnly: true + quota: + description: | + The limit of the quota (in bytes) for the specified user, cannot be `0`. + If specified, this value will override the file system's default user + quota. + type: integer + format: int64 + usage: + description: | + The usage of the file system (in bytes) by the specified user. + type: integer + format: int64 + readOnly: true + user: + description: The user on which this quota is enforced. + title: User + allOf: + - $ref: '#/components/schemas/_user' + _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: | + NFS, SMB, and SMB share policy configuration to be 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 that can be applied 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 + Realm: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + created: + description: Creation timestamp of the realm. + type: integer + format: int64 + readOnly: true + default_inbound_tls_policy: + description: | + The default TLS policy governing inbound traffic from clients accessing the accessing the realm's + network interfaces. This TLS policy will be applied for any IP addresses within the realm that do not + have a specific policy applied to them at a more granular level. If no `default_inbound_tls_policy` + is configured, then IP addresses within the realm that do not have a specific policy + applied to them at a more granular level will not be accessible using TLS. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + 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 + by setting `destroyed=false`. + type: boolean + space: + description: The space usage of the realm. + title: Space + allOf: + - $ref: '#/components/schemas/_space' + time_remaining: + description: | + Time in milliseconds before the realm is eradicated. + `null` if not destroyed. + type: integer + format: int64 + readOnly: true + _objectStoreDefault: + type: object + description: Configuration of defaults for object store. + properties: + server: + description: | + Default server for new entities created in object store. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + RealmSpace: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + space: + $ref: '#/components/schemas/_space' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + RealmSpaceStorageClass: + allOf: + - $ref: '#/components/schemas/RealmSpace' + - properties: + storage_class: + description: The name of the storage-class. + type: string + RemoteArray: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + api_versions: + $ref: '#/components/schemas/_api_versions' + fleet: + $ref: '#/components/schemas/_fixedReferenceWithIsLocal' + 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: FlashBlade//S200 + 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: 4.4.99 + ResiliencyGroupResponse: + type: object + properties: + items: + description: | + A list of resiliency group objects. + type: array + items: + $ref: '#/components/schemas/ResiliencyGroup' + ResiliencyGroupMemberResponse: + type: object + properties: + items: + description: | + A list of resiliency group and member relationships. + type: array + items: + $ref: '#/components/schemas/Member' + PageInfoScale: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + more_items_remaining: + description: | + Returns a value of `true` if subsequent items can be retrieved. + type: boolean + example: false + ResourceAccess: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - type: object + properties: + resource: + description: Resource to which the scope has access to. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + scope: + description: Scope which has access to the resource. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + Role: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + permissions: + description: A list of permissions that the role can perform. + type: array + items: + $ref: '#/components/schemas/_permission' + _s3ExportPolicyRuleInlined: + allOf: + - $ref: '#/components/schemas/_referenceNameOnly' + - $ref: '#/components/schemas/S3ExportPolicyRulePost' + S3ExportPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseContext' + - type: object + properties: + rules: + type: array + items: + allOf: + - $ref: '#/components/schemas/_s3ExportPolicyRuleInlined' + - $ref: '#/components/schemas/_policyReference' + S3ExportPolicyRule: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/S3ExportPolicyRulePost' + - $ref: '#/components/schemas/_policyReference' + _oidcSsoPostIdp: + description: Identity Provider + type: object + properties: + provider_url: + description: | + URL of the Identity Provider server + type: string + provider_url_ca_certificate: + description: | + CA certificate used to validate the authenticity of the configured + Identity Provider server. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + provider_url_ca_certificate_group: + description: | + A certificate group containing CA certificates that can be used to + validate the authenticity of the configured Identity Provider server. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + OidcSso: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/OidcSsoPost' + _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: https://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 + metadata_url_ca_certificate: + description: | + CA certificate used to validate the authenticity of the configured + Identity Provider server. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + metadata_url_ca_certificate_group: + description: | + A certificate group containing CA certificates that can be used to + validate the authenticity of the configured Identity Provider server. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + 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 certificate used by the service provider to verify the SAML response + signature from the identity provider. The credential is managed by + the `certificates` endpoint and `purecert` CLI commands. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _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 + readOnly: true + example: https://myarray.mycompany.com/login/saml2/sso/myidp + entity_id: + description: A globally unique name for the service provider. + type: string + readOnly: true + example: https://myarray.mycompany.com/saml2/service-provider-metadata/myidp + metadata_url: + description: The URL of the service provider metadata. + type: string + readOnly: true + example: https://myarray.mycompany.com/saml2/service-provider-metadata/myidp + TieringPolicyArchivalRule: + type: object + properties: + target_storage_class: + description: The storage class to which the data is moved. Will always be `S500X-A` for archival + rules. + type: string + example: S500X-A + readOnly: true + time: + description: "The time at which this rule goes into effect, in milliseconds." + type: integer + format: int64 + example: 86400000 + type: + description: | + The type of the archival rule determining when to tier data to the target storage class. + Valid values are `LATEST_ACCESS` and `LATEST_MODIFICATION`. + type: string + example: LATEST_ACCESS + TieringPolicyRetrievalRule: + type: object + properties: + target_storage_class: + description: | + The storage class to which the data is moved. Will always be `S500X-S` for retrieval rules. + type: string + example: S500X-S + readOnly: true + type: + description: | + The type of the retrieval rule determining criteria to tier data to the target storage class. + Valid values are `ON_READ` and `ONLY_ON_WRITE`. + type: string + example: ON_READ + StorageClassTieringPoliciesMembersResponse: + type: object + properties: + items: + description: A list of members for storage class tiering policies. + type: array + items: + $ref: '#/components/schemas/PolicyMember' + ServerResponseContext: + type: object + properties: + items: + description: A list of server objects. + type: array + items: + $ref: '#/components/schemas/ServerContext' + Server: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/ServerPost' + - type: object + properties: + created: + description: Creation timestamp of the server. + type: integer + format: int64 + readOnly: true + directory_services: + description: | + The directory service config to be used by this server. + type: array + maxItems: 1 + readOnly: true + items: + $ref: '#/components/schemas/_reference' + realms: + description: | + The realms containing this server. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + Session: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: | + User session logs represent user login events performed in the Purity//FB GUI, CLI, and + REST API. + type: object + properties: + end_time: + description: | + Date and time the user logged out of the Purity//FB interface in + milliseconds since UNIX epoch. Set to 0 if the session is still active. + type: integer + format: int64 + readOnly: true + example: 1502234638 + event: + description: | + Description of session events. 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 + identifying_details: + description: | + Additional details, depending on the authentication method used, + which are necessary to uniquely identify who authenticated as + a user. `null` if no additional details are needed. + type: string + readOnly: true + example: "'principal=\"john\",serial=0001,key_id=\"arbitrary CA key id text\",ssh_session_id=3233, + ca_key_fingerprint=UWRGBqyUXxTc5FKhUCw+/0tlwDXYPY1yLZk20zSCoDI'" + 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`, `password`, `ssh certificate`, + and `public key`. + type: string + readOnly: true + example: public key + start_time: + description: | + Date and time the user logged in to the Purity//FB interface + in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + example: 1502234212 + user: + description: Username of the Purity//FB 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 + SmbClientPolicyRulePostInPolicy: + allOf: + - $ref: '#/components/schemas/SmbClientPolicyRulePostBase' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + SmbClientPolicyRuleInPolicy: + allOf: + - $ref: '#/components/schemas/SmbClientPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + SmbClientPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - $ref: '#/components/schemas/_context' + - 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 + rules: + description: | + All of the rules that are part of this policy. The order is the + evaluation order. + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbClientPolicyRuleInPolicy' + workload: + $ref: '#/components/schemas/_workloadConfigurationFixedReference' + SmbClientPolicyRulePostBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + client: + description: | + Specifies the clients that will be permitted to access the export. + Accepted notation is a single IP address, subnet in CIDR notation, + or anonymous (`*`). + The default is `*` if not specified. + type: string + example: 1.2.3.4 + 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`. + 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. + type: string + SmbClientPolicyRuleBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + client: + description: | + Specifies the clients that will be permitted to access the export. + Accepted notation is a single IP address, subnet in CIDR notation, + or anonymous (`*`). + type: string + encryption: + description: | + Specifies whether the remote client is required to use SMB encryption. Valid values are + `required`, `disabled`, and `optional`. + type: string + example: optional + permission: + description: | + Specifies which read-write client access permissions are allowed for the export. + Valid values are `rw` and `ro`. + type: string + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy_version: + description: | + The policy's version. This can be used when updating the + resource to ensure there aren't any updates to the policy since the resource was read. + type: string + readOnly: true + SmbSharePolicy: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/PolicyBaseRenameable' + - type: object + properties: + rules: + description: | + All of the rules that are part of this policy. + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbSharePolicyRule' + workload: + description: | + A reference to the workload that is managing this policy. + Set the `id` or `name` of the workload to an empty string to remove the + policy from the workload. + The `name` and `configuration` may show as the string "(unknown)" briefly after a failover. + title: WorkloadConfigurationFixedReference + allOf: + - $ref: '#/components/schemas/_workloadConfigurationFixedReference' + SmbSharePolicyRuleWithContext: + allOf: + - $ref: '#/components/schemas/SmbSharePolicyRule' + - $ref: '#/components/schemas/_context' + _snmp_v2c: + description: | + The v2c configurations of SNMP. + type: object + properties: + community: + description: | + Manager community ID under which Purity is to communicate with + the specified managers. + type: string + maxLength: 32 + example: '****' + _snmp_v3: + description: | + The v3 configurations of SNMP. + type: object + properties: + auth_passphrase: + description: | + Passphrase used by Purity 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 + is to use in communications with them. + type: string + example: User1 + SnmpAgentMib: + type: object + properties: + mib: + description: MIB text. + type: string + readOnly: true + _snmp_v3_post: + description: | + The v3 configurations of SNMP. + type: object + properties: + auth_passphrase: + description: | + Passphrase used by Purity 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 + is to use in communications with them. + type: string + example: User1 + _support_remote_assist_paths: + type: object + properties: + component_name: + description: The name of the FM. + type: string + status: + description: | + The status of the remote-assist session on the local FM. + Valid values are `reconnecting`, `connected`, `disconnected`, + and `unknown`. + type: string + example: connected + VerificationKey: + type: object + properties: + key_id: + description: | + The key id of the verification key. + type: integer + format: int64 + example: 1 + name: + description: | + Name of the verification key. Possible values include `access`. + type: string + verification_key: + description: The text of the verification key. + type: string + SupportDiagnosticsResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SupportDiagnostics' + SupportDiagnosticsDetailsResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SupportDiagnosticsDetails' + 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: + - 4.1.0 + - 4.1.1 + software_version: + description: | + The version of the software that the upgrade checks will test. + type: string + example: 4.4.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 + SyslogServerPostOrPatch: + description: A syslog server + type: object + properties: + uri: + description: | + The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT. + type: string + example: tcp://my.syslogserver.com + SyslogServerContextResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SyslogServerContext' + SyslogServer: + allOf: + - $ref: '#/components/schemas/SyslogServerPost' + - $ref: '#/components/schemas/_resource' + TargetResponseContext: + type: object + properties: + items: + description: A list of target objects. + type: array + items: + $ref: '#/components/schemas/TargetWithContext' + ResourcePerformanceReplication: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + aggregate: + description: | + Total bytes transmitted or received per second for all types of + replication. + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + continuous: + description: | + Object backlog information and total bytes transmitted or received + per second for continuous replication. Continuous replication + includes object replication. + title: ContinuousReplicationPerformance + allOf: + - $ref: '#/components/schemas/_continuousReplicationPerformance' + periodic: + description: | + Total bytes transmitted or received per second for periodic + replication. Periodic replication includes file system replication, + which is snapshot based. + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + x-readOnly: true + _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' + _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 + 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. + Specify targets as individual arrays (by setting `resource_type` to `remote-arrays`) or as topology groups (by + setting `resource_type` to `topology-groups/arrays`). + Responses will have targets that are individual arrays. + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + _workloadPlacementRecommendationParameter: + allOf: + - $ref: '#/components/schemas/_workloadParameter' + - description: | + A single parameter passed to recommendation API. It could specify either a + fixed value for the parameter or define constraints with a set of allowed values. + type: object + properties: + constraints: + $ref: '#/components/schemas/_workloadPlacementRecommendationParameterConstraints' + _fixedReferenceWithoutType: + type: object + properties: + id: + description: | + A globally unique, system-generated ID. + The ID cannot be modified. + type: string + readOnly: true + name: + description: | + The resource name, such as volume name, file system name, + snapshot name, and so on. + type: string + readOnly: true + x-readOnly: true + _workloadPlacementRecommendationResult: + description: Single workload placement recommendation result. + type: object + properties: + parameters: + description: | + The parameter values to pass to the preset when creating the workload based on this + 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: | + List of all recommended arrays. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_workloadPlacementRecommendationGenericTarget' + 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/_fixedReferenceWithoutType' + value: + description: | + Value of the tag. Supports up to 256 Unicode characters. + type: string + example: staging + _wormDataPolicyRetentionConfig: + type: object + properties: + default_retention: + description: | + Default retention period, in milliseconds. If the access time is not specified + when committing a file, then the default retention period is applied. + type: integer + format: int64 + max_retention: + description: | + Maximum retention period, in milliseconds. + type: integer + format: int64 + min_retention: + description: | + Minimum retention period, in milliseconds. + type: integer + format: int64 + mode: + description: | + The type of the retention lock. Valid values is `compliance`. + type: string + retention_lock: + description: | + If set to `locked`, then the value of retention attributes or policy attributes are not + allowed to change. + If set to `unlocked`, then the value of the retention attributes and policy attributes + are allowed to change. + Valid values are `unlocked` and `locked`. It is always allowed to change from `unlocked` to + `locked`. Contact Pure Technical Services to change from `locked` to `unlocked`. + type: string + example: unlocked + _errorContextResponseErrors: + type: object + properties: + context: + description: | + Contains information relating to the cause of this error, + or the name of the object that was being processed when the error was encountered. + This may be `null` for more general errors. + type: string + location_context: + description: | + Contains information relating to the context in which the request was executing + when the error occurred. + For example, this may be the name of an array in the same fleet. + This may be `null` for more general errors, or if no explicit `context` parameter + was provided with the request. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + message: + description: A description of the error which occurred. + type: string + example: Resource does not exist. + _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 + _arrayEncryptionDataAtRest: + description: Data at Rest Encryption properties. + type: object + properties: + algorithms: + description: The algorithms used to encrypt data at rest on the array. + type: array + readOnly: true + items: + type: string + example: + - AES-256-GCM + enabled: + description: Returns a value of `true` if Data at Rest Encryption is enabled. + type: boolean + readOnly: true + entropy_source: + description: | + The entropy source used to generate the Data at Rest Encryption key on the array. + type: string + readOnly: true + example: rdseed + x-readOnly: true + _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 + _replication_performance: + type: object + properties: + received_bytes_per_sec: + description: Total bytes received per second. + type: number + format: double + minimum: 0 + readOnly: true + transmitted_bytes_per_sec: + description: Total bytes transmitted per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + _continuousReplicationPerformance: + allOf: + - $ref: '#/components/schemas/_replication_performance' + - type: object + properties: + object_backlog: + description: | + The total number of pending object operations + and their size that are currently in the backlog. + title: ObjectBacklog + allOf: + - $ref: '#/components/schemas/_objectBacklog' + x-readOnly: true + _space: + type: object + properties: + available_provisioned: + description: | + The amount of space left that the current object can grow before writes are stopped + due to a hard limit quota being hit. This is total_provisioned minus the virtual space + used for file-systems and buckets. + For array and object store accounts it is total_provisioned minus the virtual space + used by non-destroyed file-systems and buckets. + type: integer + format: int64 + minimum: 0 + example: 19937690345472 + available_ratio: + description: | + The ratio of the available space versus the total provisioned space. + type: number + format: float + minimum: 0 + maximum: 1 + data_reduction: + description: Reduction of data. + type: number + format: float + readOnly: true + destroyed: + description: | + Unique physical space (excluding snapshots) occupied by destroyed data within + the child containers, in bytes. + For buckets and filesystems, the destroyed space will be 0 as they cannot have + child containers. + For the whole array, the space will be the sum of all destroyed buckets and filesystems. + type: integer + format: int64 + readOnly: true + destroyed_virtual: + description: | + The amount of destroyed logically written data within the child containers, in bytes. + For buckets and filesystems, the destroyed virtual space will be 0 as they cannot have + child containers. + For the whole array, the space will be the sum of all destroyed buckets and filesystems. + type: integer + format: int64 + readOnly: true + shared: + description: | + The space contributed by data that is not unique to a managed directory, + or snapshot, measured in bytes. + type: integer + format: int64 + readOnly: true + snapshots: + description: "Physical usage by snapshots, other than unique in bytes." + type: integer + format: int64 + readOnly: true + total_physical: + description: | + Deprecated. See total_used for the newer functionality. + The total physical space consumed by the file system, measured in bytes. + type: integer + format: int64 + minimum: 0 + readOnly: true + total_provisioned: + description: | + The effective provisioned size of the container, at which a hard limit + will be applied. + For a bucket with a `quota_limit` value and `hard_limit_enabled` set to `true`, + this is its `quota_limit` value, unless the available space of the associated + object store account, as defined by its `quota_limit` value, would prevent the + bucket from reaching its own `quota_limit` value. In such a case, + `total_provisioned` will reflect the smaller value. + For a file system with a `provisioned` value and `hard_limit_enabled` set to + `true`, this is the `provisioned` value of the file system. + For an object store account with a `quota_limit` value and `hard_limit_enabled` + set to `true`, this is the `quota_limit` value of the object store account. + For the array, this is the sum of the file systems and accounts. + Measured in bytes. + type: integer + format: int64 + minimum: 0 + example: 19937690345472 + total_used: + description: | + The total space consumed by customer data, measured in bytes. + type: integer + format: int64 + minimum: 0 + readOnly: true + unique: + description: | + Unique physical space occupied by customer data, in bytes. + Excludes snapshots, destroyed. + type: integer + format: int64 + readOnly: true + virtual: + description: | + The amount of logically written data, in bytes. + Excludes destroyed data. + type: integer + format: int64 + readOnly: true + example: 19937690345472 + _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 + file system), or correspond to something in the environment, + like a network interface. + type: object + properties: + name: + description: | + A name chosen by the user. Can be changed. Must be locally unique. + type: string + Audit: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + arguments: + type: string + readOnly: true + command: + type: string + readOnly: true + ip_address: + type: string + readOnly: true + origin: + $ref: '#/components/schemas/_fixedReference' + scopes: + description: | + The realms and/or array which this audit affected and is visible to. + type: array + items: + $ref: '#/components/schemas/_fixedReference' + subcommand: + type: string + readOnly: true + time: + type: integer + format: int64 + readOnly: true + user: + type: string + readOnly: true + user_agent: + type: string + readOnly: true + 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 + AuditFileSystemsPolicyRuleInPolicy: + allOf: + - $ref: '#/components/schemas/AuditFileSystemsPolicyRuleBase' + AuditFileSystemsPolicyOperation: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + description: + type: string + readOnly: true + description: | + A description of the operation. + example: "Configures auditing on read, write of files in a file system." + BucketAuditFilterActionWithContext: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/BucketAuditFilterAction' + _objectLockConfigBase: + description: Configuration settings related to object lock. + type: object + properties: + default_retention_mode: + description: | + The retention mode used to apply locks on new objects if + none is specified by the S3 client. + Valid values include `compliance` and `governance`. + If there is no default, this value is `null`. + Use "" to clear. + type: string + example: governance + enabled: + description: | + If set to `true`, then S3 APIs relating to object lock + may be used. + type: boolean + freeze_locked_objects: + description: | + If set to `true`, a locked object will be read-only and no + new versions of the object may be created due to modifications. + If not specified, defaults to `false`. + type: boolean + _objectLockConfigResponse: + allOf: + - $ref: '#/components/schemas/_objectLockConfigBase' + - type: object + properties: + default_retention: + description: | + The retention period, in milliseconds, used to apply locks + on new objects if none is specified by the S3 client. + Valid values are any multiple of `86400000` (1 day), up to + `3153600000000` (36500 days). + If there is no default, this value is `null`. + type: integer + format: int64 + example: 86400000 + BucketAuditFilter: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/BucketAuditFilterBase' + - type: object + properties: + bucket: + description: Reference to the bucket to which this filter belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + CrossOriginResourceSharingPolicyRule: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRulePost' + - type: object + properties: + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + BucketAccessPolicyRule: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/BucketAccessPolicyRulePost' + - type: object + properties: + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + _direction: + type: string + description: | + The direction of replication. Valid values are `inbound` and + `outbound`. + readOnly: true + x-read-only: true + _fixedReferenceWithRemote: + allOf: + - $ref: '#/components/schemas/_fixedReference' + - type: object + properties: + remote: + description: The remote field of the corresponding array connection. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + _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/_reference' + - type: object + properties: + configuration: + description: | + The name of the preset configuration object. + type: string + _group: + type: object + properties: + id: + description: The numeric group id that represents the group's identity in a POSIX system. + type: integer + format: int64 + name: + description: | + The group name that represents the group's identity, and which resolves to the group's id + in a configured directory service. + type: string + _user: + type: object + properties: + id: + description: The numeric user id that represents the user's identity in a POSIX system. + type: integer + format: int64 + name: + description: | + The user name that represents the user's identity, and which resolves to the user's id + in a configured directory service. + type: string + _workloadConfigurationFixedReference: + 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/_fixedReference' + - type: object + properties: + configuration: + description: | + The name of the preset configuration object. + type: string + readOnly: true + PolicyFileSystemSnapshot: + allOf: + - $ref: '#/components/schemas/PolicyMember' + - $ref: '#/components/schemas/_context' + - type: object + properties: + policy: + description: Reference to the policy. + title: LocationReference + allOf: + - $ref: '#/components/schemas/_locationReference' + _memberLink: + type: object + properties: + local_file_system: + description: Reference to a local file system. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + remote: + description: Reference to a remote array. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + remote_file_system: + description: Reference to a remote file system. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + FileLock: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + access_type: + description: | + Type of access the lock provides. Valid values are `shared`, + `exclusive` and `no-access`. + type: string + readOnly: true + client: + description: | + Reference to the file system client that holds the lock. + title: FixedReferenceNoId + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoId' + created_at: + description: | + Creation timestamp of the lock. Measured in milliseconds since the UNIX + epoch. + type: integer + format: int64 + inode: + description: | + The inode of the file where the lock is found relative to the specified + `source`. + type: integer + readOnly: true + path: + description: | + Path to the file where the lock is found relative to `source`. + If it is longer than 1023 characters, it will be truncated and only + the last 1023 characters will be returned. + If multiple hard links exist to the file on which the lock is held, + only one is returned. + This field will be `null` if the path cannot be resolved. + type: string + readOnly: true + protocol: + description: | + The protocol utilized for obtaining and managing the lock. + Valid values include `NLM`, `NFSv4.1` and `SMB`. + type: string + readOnly: true + range: + $ref: '#/components/schemas/_fileLockRange' + source: + description: | + Reference to location where the path/inode can be found. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + FileSystemClient: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + FileSession: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + authentication: + description: | + Describes how was the user authenticated. + Valid values include `KRB` and `NTLMv2`. + type: string + readOnly: true + client: + description: | + Client that holds the session. + title: FixedReferenceNameOnly + allOf: + - $ref: '#/components/schemas/_fixedReferenceNameOnly' + connection_time: + description: Connection time in milliseconds since UNIX epoch. + type: integer + format: int64 + idle_time: + description: | + Duration in milliseconds that indicates how long + the session has been idle. + type: integer + format: int64 + opens: + description: Number of opens for the given session. + type: integer + format: int64 + port: + description: Port number the client is connected from. + type: integer + format: int64 + protocol: + description: | + The protocol utilized for obtaining and managing the session. + Valid values include `nfs` and `smb`. + type: string + readOnly: true + time: + description: Current time in milliseconds since UNIX epoch. + type: integer + format: int64 + user: + description: The user who has created the session. + title: User_no_id + allOf: + - $ref: '#/components/schemas/_user_no_id' + FileSystemOpenFile: + type: object + properties: + client: + description: | + Client that has the file open. + title: FixedReferenceNameOnly + allOf: + - $ref: '#/components/schemas/_fixedReferenceNameOnly' + id: + description: The unique identifier of the open file. + type: string + example: "18446744073709551615" + lock_count: + description: The number of locks on the file. + type: integer + format: int32 + minimum: 0 + mode: + description: | + The mode in which the file is open: "ro" for Read-Only, "wo" for Write-Only, "rw" for + Read-Write or "no-access" if no read or write access was granted. + type: string + path: + description: The path to the open file. + type: string + example: /fs1_export1/path/to/file1.txt + session: + description: | + The name of the session with the open file. + title: FixedReferenceNameOnly + allOf: + - $ref: '#/components/schemas/_fixedReferenceNameOnly' + source: + description: Reference to the file system. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + user: + description: The user who has the file open. + title: User_no_id + allOf: + - $ref: '#/components/schemas/_user_no_id' + _fleetMemberPostMembersMember: + 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 + _fixedReferenceWithIsLocal: + allOf: + - $ref: '#/components/schemas/_fixedReference' + - $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 + HardwareTemperaturesThresholds: + description: | + The predefined temperature thresholds for the sensor, specifying acceptable operational limits. + type: object + properties: + critical: + description: | + The temperature level indicating that the system is under increased load. + While still operational, it may require monitoring or adjustments to maintain optimal performance. + type: number + format: double + readOnly: true + non_critical: + description: | + The temperature level at which the system operates normally without any concerns. + type: number + format: double + readOnly: true + unrecoverable: + description: | + The maximum temperature limit beyond which the system may experience irreversible failure. + Immediate action is required to prevent damage or shutdown. + type: number + format: double + readOnly: true + ManagementAccessPolicyRuleBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - properties: + role: + description: | + Role defines a set of permissions applicable in a scope. `viewer` grants users + the ability to read within a scope. `support` grants the ability to perform general + support-related actions as well as read within a scope. `storage` grants access + to all storage operations within a scope. `admin` grants access to all operations. + title: ReferenceNameOnly + allOf: + - $ref: '#/components/schemas/_referenceNameOnly' + scope: + description: | + Reference to the resource (e.g. arrays, realms) which specifies the scope that + the role applies. One of `id` or `name` parameter is required, and `resource_type` + must be set. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _policyRuleIndexInPolicy: + type: object + properties: + index: + description: | + The index within the policy. The `index` indicates the order the rules are evaluated. + type: integer + format: int32 + readOnly: true + ManagementAuthenticationPolicyConfigMethod: + type: string + description: | + The name of the authentication method. Valid values are `default`, `password`, and `key`. + `default` is a special value that indicates the default authentication method for the interface, + and is potentially interface-specific and version-specific. For now, it means either `password` + or `key` is allowed. + NetworkInterfacePing: + description: | + Output from running the linux command 'ping' directly + on the array with start and end location information. + type: object + properties: + component_name: + description: Name of the component running the check. + type: string + readOnly: true + example: ch1-fm1 + destination: + description: | + The destination address or hostname provided in the request that the operation is run against. + type: string + readOnly: true + example: 181.44.543.12 + details: + description: | + Giant text block that contains raw output of the operation and a client needs to parse. + type: string + readOnly: true + source: + description: | + The address where the check starts. Can be a subnet or IP inside the subnet. + type: string + readOnly: true + example: net1 + NetworkInterfaceTrace: + description: | + Output from running the linux command 'traceroute' directly + on the array with start and end location information. + type: object + properties: + component_name: + description: Name of the component running the check. + type: string + readOnly: true + example: ch1-fm1 + destination: + description: | + The destination address or hostname provided in the request that the operation is run against. + type: string + readOnly: true + example: 181.44.543.12 + details: + description: | + Giant text block that contains raw output of the operation and a client needs to parse. + type: string + readOnly: true + source: + description: | + The address where the check starts. Can be a subnet or IP inside the subnet. + type: string + readOnly: true + example: net1 + NetworkInterfacesConnectorsSettingRoce: + description: | + RoCE(RDMA over Converged Ethernet) configuration for network connectors. + allOf: + - type: object + properties: + default_ecn: + description: | + The default ECN(Explicit Congestion Notification) setting for network connectors. + title: NetworkInterfacesConnectorsSettingRoceEcn + allOf: + - $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingRoceEcn' + default_pfc: + description: | + The default PFC(Priority Flow Control) setting for network connectors. + title: NetworkInterfacesConnectorsSettingRocePfc + allOf: + - $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingRocePfc' + enabled: + description: | + If `true`, then RoCE networking is enabled. Otherwise, it is disabled. + type: boolean + network_congestion_mode: + description: | + The RoCE network mode to be used. Valid values include `lossy` and `lossless`. + For lossy mode, only Explicit Congestion Notification (ECN) is enabled. + For lossless mode, both ECN and Priority Flow Control (PFC) are enabled. + type: string + trust_mode: + description: | + The trust mode of the RoCE network. Valid values include `pcp` and `dscp`. + type: string + NetworkConnectionStatistics: + description: | + Returns the status of the network connections on the array at the time of the operation. + type: object + properties: + current_state: + description: | + Valid values include `CLOSE_WAIT`, `CLOSED`, `ESTABLISHED`, `FIN_WAIT_1`, `FIN_WAIT_2`, + `LAST_ACK`, `LISTEN`, `SYN_RECEIVED`, `SYN_SEND`, and `TIME_WAIT` + type: string + readOnly: true + example: TIME_WAIT + local: + description: | + The information of the array's network interface to which the remote connection is bound. + title: NetworkInterfaceInfo + allOf: + - $ref: '#/components/schemas/_networkInterfaceInfo' + remote: + description: | + Network information of the remote peer that has connected to the array's network interface. + title: NetworkInterfaceInfo + allOf: + - $ref: '#/components/schemas/_networkInterfaceInfo' + time: + description: The time the operation was run. + type: integer + format: int64 + readOnly: true + example: 1735596861 + 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: NetworkInterfaceNeighborLocalPort + allOf: + - $ref: '#/components/schemas/_networkInterfaceNeighborLocalPort' + neighbor_chassis: + title: NetworkInterfaceNeighborNeighborChassis + allOf: + - $ref: '#/components/schemas/_networkInterfaceNeighborNeighborChassis' + neighbor_port: + title: NetworkInterfaceNeighborNeighborPort + allOf: + - $ref: '#/components/schemas/_networkInterfaceNeighborNeighborPort' + x-readOnly: true + ObjectStoreAccessPolicyAction: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + description: + description: | + A description of the action. + type: string + readOnly: true + example: Grants permission to create a new bucket. + _bucketDefaultsReadonly: + type: object + properties: + hard_limit_enabled: + description: | + The value of this field will be used to configure the `hard_limit_enabled` + field of newly created buckets associated with this object store account, + if the bucket creation does not specify its own value. If not specified, + defaults to `false`. + type: boolean + quota_limit: + description: | + The value of this field will be used to configure the `quota_limit` field + of newly created buckets associated with this object store account, if the + bucket creation does not specify its own value. If unset, the bucket + default is unlimited in size. + type: integer + TrustPolicyRule: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_index' + - $ref: '#/components/schemas/TrustPolicyRulePost' + _resourceFixed: + description: | + A resource that can be created, named, 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 cannot be modified. + type: string + 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/_fixedReference' + PublicKeyUse: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + use: + description: A reference to an object using this public key. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + _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: | + 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: 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: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + 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: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _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: Rules describe 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 + ResiliencyGroup: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: | + A group of nodes that are configured to provide high availability + in the case of failures within members of the group. + type: object + properties: + status: + description: | + The status of the resiliency group. + Valid values include `critical`, `healthy`, and `unhealthy`. + type: string + readOnly: true + status_details: + description: | + The description of the status of the resiliency group if not healthy. + type: string + readOnly: true + _permission: + type: object + properties: + action: + description: | + The `action` that the user can perform on the `resource_type`. + Typical values include `get`, `patch`, `post`, and `delete`. + Values can also be finer grained. + type: string + readOnly: true + example: get + resource_type: + description: The `resource_type` that this `permission` affects. + type: string + readOnly: true + example: file-systems + x-readOnly: true + _policyReference: + type: object + properties: + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + _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: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + 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: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + ServerContext: + allOf: + - $ref: '#/components/schemas/Server' + - $ref: '#/components/schemas/_context' + SupportDiagnostics: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + analysis_period: + $ref: '#/components/schemas/_start_end_time' + index: + description: The unique index of the task. + type: integer + format: int64 + readOnly: true + example: 1 + severity_count: + description: | + List of severity counts. + type: array + items: + $ref: '#/components/schemas/_supportDiagnosticsSeverityCount' + start_time: + description: Start time in milliseconds since the UNIX epoch. + type: integer + format: int64 + example: 1567026779000 + x-minimum: 0 + status: + description: | + Status of the diagnostics. + A status of `running` indicates that the diagnostics is still running. + A status of `completed` indicates that the diagnostics has completed. + A status of `failed` indicates that the diagnostics has failed. + type: string + example: completed + task_id: + description: | + A globally unique, system-generated ID. The ID cannot be modified. + type: string + readOnly: true + version: + description: Version of diagnostics tool. + type: string + example: 1.0.4.0 + SupportDiagnosticsDetails: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + index: + description: | + The unique index of the test. It will be of the format A.B + where A is the task index and B is the test index. + type: number + readOnly: true + example: 1.1 + result_details: + description: | + More details related to the test. + This field can provide remediation information as well. + type: string + example: Subnets does not exist for Mgmt services. + severity: + description: | + Severity level of the test. + Valid values include `info`, `warning`, `critical`. + type: string + example: critical + task_id: + description: | + The task ID of the diagnostics for which this refers to. + type: string + readOnly: true + test_name: + description: | + Name of the test that was performed. + type: string + example: Subnet Check For Management Service + test_type: + description: | + Category to which the test belongs to. + type: string + example: Generic + _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 + _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: Empty Chassis Check + 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 + SyslogServerContext: + allOf: + - $ref: '#/components/schemas/SyslogServer' + - $ref: '#/components/schemas/_context' + TargetWithContext: + allOf: + - $ref: '#/components/schemas/Target' + - $ref: '#/components/schemas/_context' + _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/_fixedReference' + - 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/_referenceWritable' + _workloadPlacementRecommendationParameterConstraints: + description: Constraints to apply 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/_referenceWritable' + - description: | + Data for a target in a workload placement recommendation. + Target is a array, which 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 in which this array should be used. + type: array + items: + type: string + placement_configurations: + description: | + The preset placement configurations in which this array should be used. + type: array + items: + type: string + warnings: + description: | + The warnings for the target. + type: array + items: + $ref: '#/components/schemas/_workloadPlacementRecommendationWarning' + AuditFileSystemsPolicyRuleBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - properties: + op_status: + description: | + Status of the operation to be audited by this rule. + Valid values include 'success' or failure'. + type: string + example: "success" + operations: + description: | + The list of operations to be audited by this rule. Supported ops are returned by the + /audit-file-systems-policy-operations endpoint. + type: array + items: + type: string + example: ["read", "write", "getattr"] + BucketAuditFilterAction: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + description: + description: | + A description of the action. + type: string + readOnly: true + example: Configures auditing on creation of objects in a bucket. + _fileLockRange: + description: | + The range in bytes (`offset`, `length`) the lock covers within a file. + If the lock reaches the end of the file, the `length` will be `null`. + If the lock is set for the entire file, both `offset` and `length` + will be `null`. + type: object + properties: + length: + type: integer + readOnly: true + offset: + type: integer + readOnly: true + _fixedReferenceNoId: + type: object + properties: + name: + type: string + readOnly: true + 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-readOnly: true + _user_no_id: + type: object + properties: + name: + description: | + The user name that represents the user's identity, and which resolves to the user's id + in a configured directory service. + type: string + _referenceWithoutTypeWithIsLocal: + allOf: + - $ref: '#/components/schemas/_referenceWithoutType' + - 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 + NetworkInterfacesConnectorsSettingRoceEcn: + description: | + Default ECN(Explicit Network Notification) configuration for network connectors. + allOf: + - type: object + properties: + marking_probability: + description: | + The ECN marking probability when min ECN marked threshold is reached. + type: number + format: float + readOnly: true + max_ecn_marked_threshold: + description: | + The maximum threshold value in bytes at which the packets start being marked with ECN + at the highest probability or dropped. + type: integer + format: int32 + readOnly: true + min_ecn_marked_threshold: + description: | + The minimum threshold value in bytes at which the packets start being marked with ECN. + type: integer + format: int32 + readOnly: true + NetworkInterfacesConnectorsSettingRocePfc: + description: | + Default PFC(Priority Flow Control) configuration for network connectors. + allOf: + - type: object + properties: + port_buffer: + description: | + The buffer size in bytes reserved to absorb in-flight packets after XOFF threshold + is reached. + type: integer + format: int32 + readOnly: true + xoff_threshold: + description: | + The PFC XOFF threshold value in bytes. When the buffer for a particular traffic class + reaches this threshold, the pause frame(XOFF) will be transimitted to the sender, + requesting it to stop sending packets for that class. + type: integer + format: int32 + readOnly: true + xon_threshold: + description: | + The PFC XON threshold value in bytes. When the buffer for a particular traffic class + drops below this threshold, the un-pause frame(XON) will be transmitted to the sender, + requesting it to resume sending packets for that class. + type: integer + format: int32 + readOnly: true + _networkInterfaceInfo: + type: object + properties: + address: + description: The address of the network interface. + type: string + readOnly: true + example: 168.192.0.1 + port: + description: The port number of the network interface. + type: string + readOnly: true + example: "8080" + x-readOnly: true + _networkInterfaceNeighborLocalPort: + type: object + properties: + name: + description: A name of the local port. + type: string + example: CH1.FM2.ETH1 + _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' + _index: + type: object + properties: + index: + description: Index of the object in the containing array. + type: integer + readOnly: true + _presetWorkloadConfigurationName: + type: string + description: | + The name of the configuration object, by which other configuration objects in the preset + can reference it. 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: | + A naming pattern for the name of the export used by clients to mount the file system or directory. + Export names must be unique within the same protocol+server combination. + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/_namingPattern' + servers: + description: | + An optional reference to a parameterized server resource. + Defaults to _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: | + A reference to an existing file system. + Supports parameterization. + title: ReferenceWithoutType + allOf: + - $ref: '#/components/schemas/_referenceWithoutType' + _presetWorkloadDirectoryConfigurationPath: + type: object + properties: + naming_patterns: + description: | + A naming pattern for the directory path. + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/_namingPattern' + _presetWorkloadDirectoryConfigurationSpecialDirectories: + type: object + properties: + fast_remove: + description: | + If set to "true", the file system or directory, when mounted, will + contain a directory that can be used for fast removal of other directories. + Directories can be moved into the fast remove directory in order to have + them deleted, and their space freed, more quickly than a normal removal + operation. + Defaults to "false". + Supports parameterization. + type: string + snapshot: + description: | + If set to "true", a hidden .snapshot directory will be present in each + directory of the file system when it is mounted. + The .snapshot directory allows clients read access to the contents of + the snapshots that have been taken of a directory. + If set to "false", the .snapshot directory will not be present in any + directories within a mounted file system. + Defaults to "true". + 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. + 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. + Supports parameterization. + type: string + keep_for: + description: | + Specifies the period that snapshots are retained before they are eradicated, in milliseconds. + 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. + 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. + 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: | + Logical space limit of the quota assigned by the rule, measured in bytes. + This value cannot be set to 0. + Supports parameterization. + type: string + _supportDiagnosticsSeverityCount: + type: object + properties: + count: + description: | + Count of the corresponding severity. + type: integer + example: 1 + severity: + description: | + Severity level of the test. + Valid values include `info`, `warning`, `critical`. + type: string + example: critical + _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: Constraints to apply to parameters of resource reference type. + type: object + properties: + allowed_values: + description: | + The valid values that can be supplied to the parameter to create a workload. + type: array + items: + $ref: '#/components/schemas/_referenceWithoutType' + _workloadPlacementRecommendationTarget: + allOf: + - $ref: '#/components/schemas/_referenceWritable' + - description: | + Data for a target in a workload placement recommendation. + Target is a FlashArray, which 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 + 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 + _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 an NFS export configuration defined in this preset. + type: string + smb: + description: | + The name of an SMB export configuration defined in this preset. + type: string + smb_share: + description: | + The name of an SMB share export configuration defined in this preset. + type: string + _presetWorkloadDirectoryConfigurationName: + type: object + properties: + name: + description: | + The name of a directory_configuration within this Preset. + type: string + _presetWorkloadExportConfigurationNfsPolicy: + type: object + properties: + rules: + type: array + items: + $ref: '#/components/schemas/_presetWorkloadExportConfigurationNfsRule' + user_mapping_enabled: + description: | + If "true", queries the joined AD/OpenLDAP server to find the user + corresponding to the incoming UID. + If "false", users are defined by UID/GID pair. + Supports parameterization. + type: string + _presetWorkloadExportConfigurationSmbPolicy: + 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". + Supports parameterization. + type: string + 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 "true". + 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: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _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: | + 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. + Supports parameterization. + 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. + Supports parameterization. + type: string + 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. + Supports parameterization. + type: string + atime: + description: | + If `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 `false`, disables the update of inode access times after read operations. + Defaults to `true`. + 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 + nfs_version: + description: | + The NFS protocol version allowed for the export. Valid values are `nfsv3` and `nfsv4`. + Supports parameterization. + 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 `ro` if not specified. + Supports parameterization. + type: string + secure: + description: | + If `true`, prevents NFS access to client connections coming from non-reserved ports. Applies + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + If `false`, allows NFS access to client connections coming from non-reserved ports. Applies + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + The default is `false` if not specified. + Supports parameterization. + type: string + security: + description: | + The security flavors to use for accessing files on this mount point. If the server does not + support the requested flavor, the mount operation fails. + If `sys`, trusts the client to specify user's identity. + If `krb5`, provides cryptographic proof of a user's identity 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 in order to + enable Kerberos security. + If `krb5i`, adds integrity checking to krb5, to ensure the data has not been tampered with. + If `krb5p`, adds integrity checking and encryption to krb5. This is the most secure setting, + but it also involves the most performance overhead. + The default is `sys` if not specified. + Supports parameterization. + type: array + items: + type: string + example: sys + _presetWorkloadExportConfigurationSmbRule: + type: object + properties: + anonymous_access_allowed: + description: | + Specifies whether access to information is allowed for anonymous users. + If not specified, defaults to "false". + 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: + 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 + 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 + Ids: + name: ids + in: query + description: | + A comma-separated list of resource IDs. + If after filtering, there is not at least one resource that matches + each of the elements of `ids`, then an error is returned. + This cannot be provided together with the `name` or `names` query parameters. + style: form + explode: false + schema: + type: array + items: + type: string + Offset: + name: offset + in: query + description: | + The offset of the first resource to return from a collection. + schema: + type: integer + format: int32 + minimum: 0 + example: 10 + Sort: + name: sort + in: query + description: | + Sort the response by the specified fields (in descending order if '-' + is appended to the field name). + NOTE: If you provide a sort you will not get a `continuation_token` in + the response. + style: form + explode: false + schema: + type: array + items: + pattern: "^[a-z]+(_[a-z]+)*-?" + type: string + 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 to a pre-existing account must have permissions to + 'read attributes from' and 'reset the password of' the pre-existing account. + `service_principal_names`, `encryption_types`, and `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 + Expose_api_token: + name: expose_api_token + in: query + description: | + If `true`, exposes the API token of the current user. + schema: + type: boolean + Admin_ids: + name: admin_ids + in: query + description: | + A comma-separated list of admin IDs. If after filtering, there is not + at least one admin resource that matches each of the elements, then an error + is returned. This cannot be provided together with the `admin_names` query + parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Admin_names: + name: admin_names + in: query + description: | + A comma-separated list of admin names. If there is not at least one + admin resource that matches each of the elements, then an error is returned. + This cannot be provided together with `admin_ids` query parameter. + 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 + Refresh: + name: refresh + in: query + description: | + Whether to refresh the user info from directory service. + If not specified, defaults to `false`. + schema: + type: boolean + Member_ids: + name: member_ids + in: query + description: | + A comma-separated list of member IDs. + If after filtering, there is not at least one resource that matches + each of the elements of `member_ids`, then an error is returned. + This cannot be provided together with the `member_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Member_names: + name: member_names + in: query + description: | + A comma-separated list of member names. + style: form + explode: false + schema: + type: array + items: + type: string + Policy_ids: + name: policy_ids + in: query + description: | + A comma-separated list of policy IDs. + If after filtering, there is not at least one resource that matches + each of the elements of `policy_ids`, then an error is returned. + This cannot be provided together with the `policy_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Policy_names: + name: policy_names + in: query + description: | + A comma-separated list of policy names. + 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 + Names_required: + name: names + in: query + description: | + A comma-separated list of resource names. + required: true + style: form + explode: false + schema: + type: array + items: + type: string + Total_only: + name: total_only + in: query + description: | + If set to `true`, returns the aggregate value of all items after filtering. + Where it makes more sense, the average value is displayed instead. + The values are displayed for each name where meaningful. + If `total_only=true`, the `items` list will be empty. + schema: + type: boolean + Protocol_clients: + name: protocol + in: query + description: | + Display the performance of a specified protocol. + Valid values are `NFS`, and `S3`. + If not specified, defaults to `NFS`. + schema: + 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 + Remote_ids_deprecated: + name: remote_ids + in: query + description: | + A comma-separated list of remote array IDs. Deprecated, best practice is to reference connections + with `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_deprecated: + name: remote_names + in: query + description: | + A comma-separated list of remote array names. Deprecated, best practice is to reference + connections with `ids`. If there is not at least one resource that matches each of the elements, + then an error is returned. This cannot be provided together with `remote_ids` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + End_time: + name: end_time + in: query + description: | + When the time window ends (in milliseconds since epoch). + schema: + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + Resolution: + name: resolution + in: query + description: | + The desired ms between samples. Available resolutions may + depend on data type, `start_time` and `end_time`. + In general `1000`, `30000`, `300000`, `1800000`, `7200000`, and + `86400000` are possible values. + schema: + type: integer + format: int64 + minimum: 0 + example: 30000 + Start_time: + name: start_time + in: query + description: | + When the time window starts (in milliseconds since epoch). + schema: + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + Type_for_performance: + name: type + in: query + description: | + Display the metric of a specified object type. + Valid values are `all`, `file-system`, and `object-store`. + If not specified, defaults to `all`. + schema: + type: string + Protocol: + name: protocol + in: query + description: | + Display the performance of a specified protocol. + Valid values are `all`, `HTTP`, `SMB`, `NFS`, and `S3`. + If not specified, defaults to `all`, which will provide + the combined performance of all available protocols. + schema: + type: string + Type: + name: type + in: query + description: | + Display the metric of a specified object type. + Valid values are `array`, `file-system`, and `object-store`. + If not specified, defaults to `array`. + schema: + type: string + StorageClassNames: + name: storage_class_names + in: query + description: | + A comma-separated list of storage class names. Valid values include `S500X-S` and `S500X-A`. + style: form + explode: false + schema: + type: array + items: + type: string + Eradicate_all_data_required: + name: eradicate_all_data + in: query + required: true + description: | + Set to `true` to perform a factory reset. + schema: + type: boolean + default: true + Preserve_configuration_data_required: + name: preserve_configuration_data + in: query + required: true + description: | + For the initial phase `none` is only acceptable value for this parameter + schema: + type: string + default: none + Skip_phonehome_check: + name: skip_phonehome_check + in: query + required: true + description: | + A flag to skip phonehome connectivity check. + Arrays that intentionally disable phonehome or do not permit connectivity + to Pure Storage's cloud servers must set this flag to `true` in order to start factory reset. + schema: + type: boolean + default: false + Delete_sanitization_certificate_required: + name: delete_sanitization_certificate + in: query + required: true + description: | + Must be `true` to finalize factory reset and acknowledge the deletion of sanitization certificate. + schema: + type: boolean + default: true + Finalize_array_erasure_required: + name: finalize + in: query + required: true + description: | + Must be `true` to finalize factory reset. + schema: + type: boolean + default: true + 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 + Cancel_storage_class_transition: + name: cancel_in_progress_storage_class_transition + in: query + description: | + If set to `true`, the storage class policy of this file system + will be set to the requested storage class policy, even if + a transition to a different storage class is in-progress. + Setting this parameter to `true` is acknowledgement that any + in-progress transition on this file system will be cancelled. + If not specified, the default value is `false`. + schema: + type: boolean + Ignore_usage: + name: ignore_usage + in: query + description: | + Allow update operations that lead to a `hard_limit_enabled` object store + account, bucket, or file system with usage over its limiting value. + For object store accounts and buckets, the limiting value is that of `quota_limit`, + and for file systems it is that of `provisioned`. + The operation can be setting `hard_limit_enabled` when usage is higher + than the limiting value, modifying the limiting value to a value under usage when + `hard_limit_enabled`, recovering a destroyed bucket of an object store account + that causes an account's space usage to go over its hard `quota_limit`. + Also allows update operations that would cause usage of the requested + storage class to go over its warning threshold. + 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 + Local_bucket_ids: + name: local_bucket_ids + in: query + description: | + A comma-separated list of local bucket 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_bucket_names` + query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Local_bucket_names: + name: local_bucket_names + in: query + description: | + A comma-separated list of local bucket names. If there is not at least one + resource that matches each of the elements, then an error is returned. This + cannot be provided together with `local_bucket_ids` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Remote_bucket_names: + name: remote_bucket_names + in: query + description: | + A comma-separated list of remote bucket names. If 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_credentials_ids: + name: remote_credentials_ids + in: query + description: | + A comma-separated list of remote credentials 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_credentials_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Remote_credentials_names: + name: remote_credentials_names + in: query + description: | + A comma-separated list of remote credentials names. If 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_credentials_ids` query + parameter. + style: form + explode: false + schema: + type: array + items: + type: string + 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: | + A comma-separated list of certificate names. + If there is not at least one resource that matches each of the + elements of `certificate_names`, then an error is returned. + This cannot be provided in conjunction with the `certificate_ids` + parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Ids_for_directory_service_roles: + name: ids + in: query + description: | + A comma-separated list of resource IDs. + If after filtering, there is not at least one resource that matches + each of the elements of `ids`, then an error is returned. + This cannot be provided together with the `names`, `role_names`, + or `role_ids` query parameters. + style: form + explode: false + schema: + type: array + items: + type: string + Names_for_directory_service_roles: + name: names + in: query + description: | + A comma-separated list of resource IDs. + If after filtering, there is not at least one resource that matches + each of the elements of `names`, then an error is returned. + This cannot be provided together with the `ids`, `role_names`, + or `role_ids` query parameters. + style: form + explode: false + schema: + type: array + items: + type: string + Role_ids: + name: role_ids + in: query + description: | + A comma-separated list of role_ids. + If after filtering, there is not at least one resource that matches + each of the elements of `role_ids`, then an error is returned. + This cannot be provided together with the `ids`, `names` or + `role_names` query parameters. + This query parameter is deprecated for use with directory service + roles. If this parameter is used to query or modify directory + service roles, but more than 1 configuration exists with a given + role id, an error will be returned in order to avoid ambiguous + operation. + style: form + explode: false + schema: + type: array + items: + type: string + Role_names: + name: role_names + in: query + description: | + A comma-separated list of role_names. + If there is not at least one resource that matches + each of the elements of `role_names`, then an error is returned. + This cannot be provided together with the `ids`, `names`, + or `role_ids` query parameters. + This query parameter is deprecated for use with directory service + roles. If this parameter is used to query or modify directory + service roles, but more than 1 configuration exists with a given + role name, an error will be returned in order to avoid ambiguous + operation. + 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 + Default_exports: + name: default_exports + in: query + description: | + A comma-separated list of export types to be created using default access. + Creating a file system with an explicit `nfs.rules` or `nfs.export_policy` value will always + create a NFS export to the default server regardless of this flag. If these are not set and + `default_exports` includes `nfs`, then `nfs.rules` will be set to "*(rw,no_root_squash)" + and a NFS export to the default server will be created. Otherwise `nfs.rules` will be set to "" + and no NFS export will be created. + Creating a file system with an explicit `smb.client_policy` or `smb.share_policy` value will + always create a SMB export to the default server regardless of this flag. If these are not set + and `default_exports` includes `smb`, then a SMB export to the default server will be + created with default policies. Otherwise no SMB export will be created. + Use empty string ("") to not create these default exports. + Default is `nfs,smb`. + style: form + explode: false + schema: + type: array + items: + type: string + example: "nfs,smb" + Discard_non_snapshotted_data: + name: discard_non_snapshotted_data + in: query + description: | + This parameter must be set to `true` in order to restore + a file system from a snapshot or to demote a file system + (which restores the file system from the common baseline + snapshot). Setting this parameter to `true` is acknowledgement + that any non-snapshotted data currently in the file system + will be irretrievably lost. + schema: + type: boolean + Overwrite: + name: overwrite + in: query + description: | + When used for snapshot restore, overwrites (`true`) an existing file system. + schema: + type: boolean + Delete_link_on_eradication: + name: delete_link_on_eradication + in: query + description: | + If set to `true`, the file system can be destroyed, even if it has a replica link. + If set to `false`, the file system cannot be destroyed if it has a replica link. + Defaults to `false`. + schema: + type: boolean + Discard_detailed_permissions: + name: discard_detailed_permissions + in: query + description: | + This parameter must be set to `true` in order to change + a file system's `access_control_style` from a style that + supports more detailed access control lists to a style that + only supports less detailed mode bits as a form of permission + control. + This parameter may not be set to `true` any other time. + Setting this parameter to `true` is acknowledgement that any + more detailed access control lists currently set within the + file system will be lost, and NFS permission controls will + only be enforced at the granularity level of NFS mode bits. + schema: + type: boolean + File_system_ids: + name: file_system_ids + in: query + description: | + A comma-separated list of file system IDs. + If after filtering, there is not at least one resource that matches + each of the elements of `file_system_ids`, then an error is returned. + This cannot be provided together with the `file_system_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + File_system_names: + name: file_system_names + in: query + description: | + A comma-separated list of file system names. + If there is not at least one resource that matches + each of the elements of `file_system_names`, then an error is returned. + style: form + explode: false + schema: + type: array + items: + type: string + Gids_not_strict: + name: gids + in: query + description: | + A comma-separated list of group IDs. + This cannot be provided together with `group_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Group_names_not_strict: + name: group_names + in: query + description: | + A comma-separated list of group names. + This cannot be provided together with `gids` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Uids_not_strict: + name: uids + in: query + description: | + A comma-separated list of user IDs. + This cannot be provided together with `user_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + User_names_not_strict: + name: user_names + in: query + description: | + A comma-separated list of user names. + This cannot be provided together with `uids` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Local_file_system_ids: + name: local_file_system_ids + in: query + description: | + A comma-separated list of local file system 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_file_system_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Local_file_system_names: + name: local_file_system_names + in: query + description: | + A comma-separated list of local file system names. If there is not + at least one resource that matches each of the elements, then an error + is returned. This cannot be provided together with `local_file_system_ids` + query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Remote_file_system_ids: + name: remote_file_system_ids + in: query + description: | + A comma-separated list of remote file system IDs. If 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_file_system_names` + query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Remote_file_system_names: + name: remote_file_system_names + in: query + description: | + A comma-separated list of remote file system names. If 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_file_system_ids` + query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Cancel_in_progress_transfers: + name: cancel_in_progress_transfers + in: query + description: | + This parameter must be set to `true` in order to delete + a file system replication link (which can cancel any + in-progress replication transfers). Setting this parameter + to `true` is acknowledgement that any in-progress replication + transfers on the specified links will be cancelled when + this request is fulfilled. + schema: + type: boolean + Replicate_now: + name: replicate_now + in: query + description: | + If set to `true`, replicates the contents to the specified targets. + The `replicate_now` parameters can only be `true` with the partial-replica file system links. + schema: + type: boolean + Names_or_owner_names: + name: names_or_owner_names + in: query + description: | + A comma-separated list of resource names. + Either the names of the snapshots or the owning file systems. + style: form + explode: false + schema: + type: array + items: + type: string + Owner_ids: + name: owner_ids + in: query + description: | + A comma-separated list of owning file system IDs. + If after filtering, there is not at least one resource that matches + each of the elements of owner IDs, then an error is returned. + This cannot be provided together with the `ids`, `names_or_owner_names`, + or `names_or_sources` query parameters. + style: form + explode: false + schema: + type: array + items: + type: string + Send: + name: send + in: query + description: | + Whether to replicate created snapshots immediately to other arrays. + If it's `false`, created snapshots may still be replicated to other arrays + according to policy. + schema: + type: boolean + Source_ids: + name: source_ids + in: query + description: | + A comma-separated list of source file system IDs. + If after filtering, there is not at least one resource that matches + each of the elements of `source_ids`, then an error is returned. + This cannot be provided together with the `names_or_sources` or + `sources` query parameters. + style: form + explode: false + schema: + type: array + items: + type: string + Source_names: + name: source_names + in: query + description: | + A comma-separated list of names for the source of the object. + If there is not at least one resource that matches each of the elements of + `source_names`, an error is returned. + style: form + explode: false + schema: + type: array + items: + type: string + Targets: + name: targets + in: query + description: | + The target arrays to replicate created snapshots to. + Only valid when `send` is `true`. + style: form + explode: false + schema: + type: array + items: + type: string + Latest_replica: + name: latest_replica + in: query + description: | + Used when destroying a snapshot. If not present or `false`, and the snapshot + is the latest replicated snapshot, then destroy will fail. If `true` or the + snapshot is not the latest replicated snapshot, then destroy will be + successful. + schema: + type: boolean + Client_names: + name: client_names + in: query + description: | + A comma-separated list of ip addresses of clients. + For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened + format are supported. + style: form + explode: false + schema: + type: array + items: + type: string + Inodes: + name: inodes + in: query + description: | + A comma-separated list of inodes used for filtering file locks query by inodes. + This may only be specified if `file_system_ids` or `file_system_names` is + also specified. + This cannot be provided together with the `paths` query parameter. + style: form + explode: false + schema: + type: array + items: + type: number + Paths: + name: paths + in: query + description: | + A comma-separated list of paths used for filtering file locks query by paths. + This may only be specified if `file_system_ids` or `file_system_names` is + also specified. + This cannot be provided together with the `inodes` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Recursive: + name: recursive + in: query + description: | + Flag used to indicate that the action should be done recursively. + If set to `true` and used e.g. with `path` pointing to a directory, the + operation will delete all locks in given directory and subdirectories recursively. + For more fine grained control over deleted locks, use delete by name. + If not specified, defaults to `false`. + schema: + type: boolean + Protocols: + name: protocols + in: query + description: | + A comma-separated list of file protocols. + Valid values include `nfs` and `smb`. + style: form + explode: false + schema: + type: array + items: + type: string + Sessions_user_names: + name: user_names + in: query + description: | + A comma-separated list of user names. + style: form + explode: false + schema: + type: array + items: + type: string + Disruptive: + name: disruptive + in: query + description: | + If set to `true`, a wide scope of sessions may be deleted + in a single action using a single query parameter from + `user_names`, `client_names`, or `protocols`. Otherwise, + multiple query parameters must be specified to narrow + the impact of deletion and avoid potential for accidental + disruption of clients. + schema: + type: boolean + Open_files_paths: + name: paths + in: query + description: | + A comma-separated list of paths used for filtering open files query. + style: form + explode: false + schema: + type: array + items: + type: string + example: "/fs1_export1/path/to/file1,/fs1_export1/path/to/file2" + Open_files_user_names: + name: user_names + in: query + description: | + A comma-separated list of user names used for filtering open files query. + Files opened by any of the specified users will be returned. + style: form + explode: false + schema: + type: array + items: + type: string + example: "DomainName\\User1,DomainName\\User2" + Protocols_required: + name: protocols + in: query + description: | + A comma-separated list of file protocols. + Valid values include `nfs` and `smb`. + required: true + style: form + explode: false + schema: + type: array + items: + type: string + Session_names: + name: session_names + in: query + description: | + A comma-separated list of session names used for filtering open files query. + Files opened in any of the specified sessions will be returned. + style: form + explode: false + schema: + type: array + 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 + 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 + 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 + Name_prefixes: + name: name_prefixes + in: query + description: | + The prefix to use for the names of all Kerberos keytab objects + that are being created. + schema: + type: string + Keytab_ids: + name: keytab_ids + in: query + description: | + A comma-separated list of keytab 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 `keytab_names` query + parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Keytab_names: + name: keytab_names + in: query + description: | + A comma-separated list of keytab names. If there is not at least one + resource that matches each of the elements, then an error is returned. This + cannot be provided together with `keytab_ids` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Legal_holds_recursive: + name: recursive + in: query + description: | + This is a flag to set when recursively applying/releasing legal holds on entities. + By default, it is set to be false. + The `recursive` flag is required when applying/releasing a hold to/from a directory. + schema: + type: boolean + default: false + Legal_holds_release: + name: released + in: query + description: | + This is a flag to set when releasing an attached legal hold from a path. + required: true + schema: + type: boolean + default: true + 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 + Management_access_policies_member_types: + name: member_types + in: query + description: | + A comma-separated list of member types. Valid values are `admins` and `arrays`. + style: form + explode: false + schema: + type: array + items: + type: string + Versions: + name: versions + in: query + description: | + A comma-separated list of versions. This is an optional query param used for concurrency control. + The ordering should match the names or ids query param. + This will fail with a 412 Precondition failed if the resource was changed and the current + version of the resource doesn't match the value in the query param. + style: form + explode: false + schema: + type: array + items: + type: string + Before_rule_id: + name: before_rule_id + in: query + description: | + The id of the rule to insert or move a rule before. + This cannot be provided together with the `before_rule_name` query parameter. + schema: + type: string + Before_rule_name: + name: before_rule_name + in: query + description: | + The name of the rule to insert or move a rule before. + This cannot be provided together with the `before_rule_id` query parameter. + schema: + type: string + Packet_size: + name: packet_size + in: query + description: | + Used by ping to specify the number of data bytes to be sent per packet. + If not specified, defaults to 56. + schema: + type: integer + format: int32 + example: 56 + Ping_count: + name: count + in: query + description: | + Used by ping to specify the number of packets to send. + If not specified, defaults to 1. + schema: + type: integer + format: int32 + Ping_trace_component: + name: component_name + in: query + description: | + Used by ping and trace to specify where to run the operation. Valid values are controllers + and blades from hardware list. + If not specified, defaults to all available controllers and selected blades. + schema: + type: string + Ping_trace_destination: + name: destination + in: query + description: | + A destination specified by user to run the network diagnosis against. Can be a hostname or an IP. + required: true + schema: + type: string + example: www.test.com + Ping_trace_source: + name: source + in: query + description: | + Used by ping and trace to specify the property where to start + to run the specified operation. The property can be subnet or + IP. + schema: + type: string + Print_latency: + name: print_latency + in: query + description: | + Used by ping to specify whether or not to print + the full user-to-user latency. If not specified, defaults to false. + schema: + type: boolean + Resolve_hostname: + name: resolve_hostname + in: query + description: | + Used by ping and trace to specify whether or not to + map IP addresses to host names. If not specified, defaults to true. + schema: + type: boolean + Fragment_packet: + name: fragment_packet + in: query + description: | + Used by trace to specify whether or not to + fragment packets. If not specified, defaults to true. + schema: + type: boolean + Method: + name: method + in: query + description: | + Used by trace to specify which method to use for trace operations. Valid + values are `icmp`, `tcp`, and `udp`. If not specified, defaults to 'udp'. + schema: + type: string + Mtu: + name: discover_mtu + in: query + description: | + Used by trace to specify whether or not to discover + the MTU along the path being traced. If not specified, defaults to false. + schema: + type: boolean + Port: + name: port + in: query + description: | + Used by trace to specify a destination port. + schema: + type: string + NetworkConnectionStatisticsCurrent_state: + name: current_state + in: query + description: | + The state to filter the results by. If specified, the results will + only include connections which current state matches the specified states. + style: form + explode: false + schema: + type: array + items: + type: string + NetworkConnectionStatisticsLocal_host: + name: local_host + in: query + description: | + The local IP address to filter the results by. If specified, the results will + only include connections that are either to or from the specified local host. + style: form + explode: false + schema: + type: array + items: + type: string + NetworkConnectionStatisticsLocal_port: + name: local_port + in: query + description: | + The local port to filter the results by. If specified, the results will + only include connections that are either to or from the specified local port. + style: form + explode: false + schema: + type: array + items: + type: integer + NetworkConnectionStatisticsRemote_host: + name: remote_host + in: query + description: | + The remote IP address to filter the results by. If specified, the results will + only include connections that are either to or from the specified remote host. + style: form + explode: false + schema: + type: array + items: + type: string + NetworkConnectionStatisticsRemote_port: + name: remote_port + in: query + description: | + The remote port to filter the results by. If specified, the results will + only include connections that are either to or from the specified remote port. + style: form + explode: false + schema: + type: array + items: + type: integer + 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 + 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, `CH1.FM2.ETH1,CH1.FM1.ETH2`. + style: form + explode: false + schema: + type: array + items: + type: string + Add_to_groups: + name: add_to_groups + in: query + description: | + If `true`, the node being added will automatically be added + to all node groups that other members of its resiliency + group already belong to. This parameter must be set to `true` + when adding any node that will be part of a resiliency group. + schema: + type: boolean + Node_group_ids: + name: node_group_ids + in: query + description: | + A comma-separated list of node group ids. + If there is not at least one resource that matches each of the + elements of `node_group_ids`, then an error is returned. + This cannot be provided in conjunction with the `node_group_names` parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Node_group_names: + name: node_group_names + in: query + description: | + A comma-separated list of node group names. + If there is not at least one resource that matches each of the + elements of `node_group_names`, then an error is returned. + This cannot be provided in conjunction with the `node_group_ids` parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Node_ids: + name: node_ids + in: query + description: | + A comma-separated list of node ids. + If there is not at least one resource that matches each of the + elements of `node_ids`, then an error is returned. + This cannot be provided in conjunction with the `node_names` + parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Node_names: + name: node_names + in: query + description: | + A comma-separated list of node names. + If there is not at least one resource that matches each of the + elements of `node_names`, then an error is returned. + This cannot be provided in conjunction with the `node_ids` + parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Access_key_names: + name: names + in: query + description: | + A comma-separated list of resource names to import. + To import a set of credentials, this field must be specified + with the `secret_access_key` body parameter. If both of these + are not specified, the system will generate a new set of credentials. + + A matching realm prefix is required when importing credentials for + a user in a realm. For example, use + `realm1::PSFBSAZRBHOODCBADKNFKCBCPCNHLHMEJOIOHHBACEL` when importing + credentials for user `realmName::accountName/userName`. + 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 + Enforce_action_restrictions: + name: enforce_action_restrictions + in: query + description: | + Certain combinations of actions and other rule elements are inherently ignored + if specified together in a rule. + If set to `true`, operations which attempt to set these combinations will + fail. + If set to `false`, such operations will instead be allowed. + Defaults to `true`. + schema: + type: boolean + Object_store_role_ids: + name: role_ids + in: query + description: | + A comma-separated list of object store role IDs. + If after filtering, there is not at least one resource that matches + each of the elements of `role_ids`, then an error is returned. + This cannot be provided together with the `role_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Object_store_role_names: + name: role_names + in: query + description: | + A comma-separated list of object store role names. + If there is not at least one resource that matches + each of the elements of `role_names`, then an error is returned. + This cannot be provided together with the `role_ids` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Indices: + name: indices + in: query + description: | + A comma-separated list of resource indices. + If there is not at least one resource that matches + each of the elements of `indices`, then an error is returned. + style: form + explode: false + schema: + type: array + items: + type: integer + Full_access: + name: full_access + in: query + description: | + If set to `true`, creates an object store user with full permissions. + If set to `false`, creates an object store user with no permission. + If not specified, defaults to `false`. + schema: + type: boolean + Destroy_snapshots: + name: destroy_snapshots + in: query + description: | + This parameter must be set to `true` in order to modify a policy such + that local or remote snapshots would be destroyed. + schema: + type: boolean + Member_types: + name: member_types + in: query + description: | + A comma-separated list of member types. Valid values include `file-systems`, + `file-system-snapshots`, `file-system-replica-links`, `object-store-users`, + and `object-store-accounts`. Different endpoints may accept different subsets + of these values. + style: form + explode: false + schema: + type: array + items: + type: string + Member_types_qos: + name: member_types + in: query + description: | + A comma-separated list of member types. Valid values are `file-systems`, `realms`, and `buckets` + style: form + explode: false + schema: + type: array + items: + type: string + Member_types_qos_no_buckets: + name: member_types + in: query + description: | + A comma-separated list of member types. Valid values are `file-systems`, `realms` + style: form + explode: false + schema: + type: array + items: + type: string + Gids: + name: gids + in: query + description: | + A comma-separated list of group IDs. + If there is not at least one resource that matches + each of the elements of `gids`, then an error is returned. + This cannot be provided together with `group_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + Group_names: + name: group_names + in: query + description: | + A comma-separated list of group names. + If there is not at least one resource that matches + each of the elements of `group_names`, then an error is returned. + This cannot be provided together with `gids` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Uids: + name: uids + in: query + description: | + A comma-separated list of user IDs. + If there is not at least one resource that matches + each of the elements of `uids`, then an error is returned. + This cannot be provided together with `user_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + User_names: + name: user_names + in: query + description: | + A comma-separated list of user names. + If there is not at least one resource that matches + each of the elements of `user_names`, then an error is returned. + This cannot be provided together with `uids` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + 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 + Without_default_access_list: + name: without_default_access_list + in: query + description: | + Specifying this option ensures a realm is created without any resource accesses. + required: true + schema: + type: boolean + Realm_ids: + name: realm_ids + in: query + description: | + A comma-separated list of realm 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 + `realm_names` query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Realm_names: + name: realm_names + in: query + description: | + A comma-separated list of realm names. If there is not + at least one resource that matches each of the elements, then an error + is returned. This cannot be provided together with `realm_ids` + query parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Resiliency_group_ids: + name: resiliency_group_ids + in: query + description: | + A comma-separated list of resiliency group IDs. + If there is not at least one resource that matches each of the + elements of `resiliency_group_ids`, then an error is returned. + This cannot be provided in conjunction with the `resiliency_group_names` parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Resiliency_group_names: + name: resiliency_group_names + in: query + description: | + A comma-separated list of resiliency group names. + If there is not at least one resource that matches each of the + elements of `resiliency_group_names`, then an error is returned. + This cannot be provided in conjunction with the `resiliency_group_ids` parameter. + style: form + explode: false + schema: + type: array + items: + type: string + Limit_scale: + name: limit + in: query + description: | + Limit the size of the response to the specified number of resources. + A `limit` of `0` can be used to get the number of resources without getting + all of the resources. It will be returned in the `total_item_count` field. + If a client asks for a page size larger than the available number, the request + is still valid. In that case the server just returns the available number of + items, disregarding the client's page size request. + If the page size requested is larger than the system maximum limit, + the server returns the maximum limit, disregarding the requested page size. + If there are additional items `more_items_remaining` will be set to true. + Additional items can be fetched using the `offset` or `continuation_token` query + params. + schema: + type: integer + format: int32 + minimum: 0 + example: 10 + Create_ds: + name: create_ds + in: query + description: | + The name of the directory service object to create used for NFS access to this server. + The name must be the server `name` followed by _nfs. + required: true + schema: + type: string + example: server1_nfs + Cascade_delete: + name: cascade_delete + in: query + description: | + The resource types to delete when deleting this object. It will fail if the resources are + referenced by other objects. + Valid values include `directory-services`. + required: true + style: form + explode: false + schema: + type: array + items: + type: string + example: directory-services + 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 + Analysis_period_end_time: + name: analysis_period_end_time + in: query + description: | + When the analysis time window ends (in milliseconds since epoch). + schema: + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + Analysis_period_start_time: + name: analysis_period_start_time + in: query + description: | + When the analysis time window starts (in milliseconds since epoch). + schema: + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + 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_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 + Names_for_syslog: + name: names + in: query + description: | + Performs the operation on the unique name specified. + Enter multiple names in comma-separated format. + For example, `name01,name02`. + style: form + explode: false + schema: + type: array + items: + type: string + Effective_tls_policy: + name: effective + in: query + description: | + If `true`, then the TLS policies returned will be fully evaluated. This + involves expanding shortened TLS ciphers, removing disabled TLS ciphers from + the list of expanded enabled TLS ciphers, and converting values such as + `default` and `legacy` into concrete values, in order to return the discrete + effective TLS settings that the policies encode. + Defaults to `false`. + schema: + type: boolean + Purity_defined: + name: purity_defined + in: query + description: | + If `true`, then the results returned will be include the specification + for purity-defined values on the current purity version. These values + may be used in configurations in order to dynamically adopt new behavior + across upgrades, and this option allows the exact behavior for the current + version to be returned. + Defaults to `false`. + schema: + type: boolean + 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 + Namespaces: + name: namespaces + in: query + description: | + A comma-separated list of namespaces. + 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 + Keys: + name: keys + in: query + description: | + A comma-separated list of tag keys. + style: form + explode: false + schema: + type: array + items: + type: string + Namespaces_delete: + name: namespaces + in: query + description: | + A comma-separated list of namespaces. Only one namespace is allowed per delete request. + style: form + explode: false + schema: + type: array + items: + type: string + responses: + OauthToken200: + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + 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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + 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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + type: object + properties: + error: + type: string + example: invalid_client + error_description: + type: string + example: "Invalid identity: JWT validation failed." diff --git a/html/spec_index.yaml b/html/spec_index.yaml index a4d42a5..605f372 100644 --- a/html/spec_index.yaml +++ b/html/spec_index.yaml @@ -508,6 +508,12 @@ url: specs/FB2.22.spec.yaml version: '2.22' version_sort: 2222 +- filename: FB2.23.spec.yaml + model: FlashBlade + name: FlashBlade v2.23 + url: specs/FB2.23.spec.yaml + version: '2.23' + version_sort: 2223 - filename: Pure1-1.0.spec.yaml model: Pure1 name: Pure1 v1.0 diff --git a/html/specs/FB2.23.spec.yaml b/html/specs/FB2.23.spec.yaml new file mode 100644 index 0000000..e3a8054 --- /dev/null +++ b/html/specs/FB2.23.spec.yaml @@ -0,0 +1,39437 @@ +openapi: 3.0.1 +info: + title: FlashBlade REST API + description: "## Pure Swagger UI for FlashBlade\nA light weight tool to explore + the API for FlashBlade, community supported. \nFor help with this tool, use [Pure1 + Community](https://community.purestorage.com/) or the [code-purestorage Slack](https://community.purestorage.com/discussion/9561/join-the-new-pure-code-slack-team-for-api-and-extensibility-discussions)\n\n## + Authentication\nUse an api-token (header param) to start a session at /api/login, + that returns an x-auth-token header which expires in 30 minutes by default. This + is\ndifferent than FlashArray, which uses a cookie instead. The x-auth-token + is saved and added by the built in proxy server.\n\nUse \"pureadmin create --api-token\" + on the CLI to create an API Token. Or use \"pureadmin list --api-token --expose\" + to show a token already created. Note, it only shows tokens for user that is + logged in.\n\n## Proxy\nThis Swagger tool includes a proxy server that forwards + API calls to the array. In the Swagger UI, you will \\\nsee curl API calls to + IP 127.0.0.1, that is the proxy server. To see the API call details view the console + output.\n\n## Error Codes\nUse HTTP Response codes to determine command results. + \ Error message json formats are different depending on the endpoint.\n\n## Official + Documentation\nGo to the Pure support portal for the [full documentation](https://support.purestorage.com/FlashBlade/Purity_FB/Purity%2F%2F%2F%2FFB_REST_API/Management_REST_API/Management_REST_API_Reference_Guides)." + version: '2.23' + x-pure-description-ref: ../custom_descriptions/FB-api-introduction.md + x-logo: + url: + $ref: ../redoc/PS-LogoBase64-FA.txt +security: +- AuthorizationHeader: [] +paths: + /oauth2/1.0/token: + post: + tags: + - Authorization + summary: 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: GET api_version + description: 'Get available API versions. No authentication is required to access + this endpoint. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Api_version' + security: [] + /api/login: + post: + description: Create a new session with API_KEY + responses: + '200': + description: User logged in + headers: + x-auth-token: + description: authentication token, pass this back for future API Calls. + schema: + type: string + content: + application/json: + schema: + type: object + properties: + username: + type: string + description: The user name logged in. + example: + username: pureuser + tags: + - Authorization + parameters: + - in: header + name: api-token + required: true + schema: + type: string + /api/logout: + post: + tags: + - Authorization + summary: POST logout + description: 'Invalidate a REST session token. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/login-banner: + get: + tags: + - Authorization + summary: GET login_banner + description: 'Get the login banner for the array. No authentication is required + to access this endpoint. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/LoginBannerGetResponse' + security: [] + /api/2.23/active-directory: + get: + tags: + - Active Directory + summary: GET active-directory + description: List Active Directory accounts and their configuration. + parameters: + - $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' + 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/ActiveDirectoryGetResponse' + post: + tags: + - Active Directory + summary: POST active-directory + description: 'Join an Active Directory domain and generate keytabs for the + + registered SPNs and supported encryption types. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Join_existing_acct_ad' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ActiveDirectoryPost' + required: true + x-codegen-request-body-name: active-directory + 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/ActiveDirectoryResponse' + x-codegen-request-body-name: active-directory + delete: + tags: + - Active Directory + summary: DELETE active-directory + description: Delete an Active Directory account. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_only_ad' + - $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: + - Active Directory + summary: PATCH active-directory + description: Modify the configuration of an Active Directory account. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ActiveDirectoryPatch' + required: true + x-codegen-request-body-name: active-directory + 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/ActiveDirectoryResponse' + x-codegen-request-body-name: active-directory + /api/2.23/active-directory/test: + get: + tags: + - Active Directory + summary: GET active-directory/test + description: 'Executes a series of tests to verify if the configuration of one + or more Active Directory accounts are functioning properly. Each test verifies + a different aspect of the configuration. + + ' + 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/Sort' + 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/TestResultRemoteExecutionGet' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TestResultRemoteExecutionGet' + /api/2.23/admins: + get: + tags: + - Administrators + summary: GET admins + description: List the administrator's attributes, including the API token and + public key. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Expose_api_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' + 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/AdminGetResponse' + post: + tags: + - Administrators + summary: POST admins + description: Create a new local administrator. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AdminResponse' + x-codegen-request-body-name: admin + delete: + tags: + - Administrators + summary: DELETE admins + description: Delete a local administrator.. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Administrators + summary: PATCH admins + description: Modify the attributes of an administrator. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AdminResponse' + x-codegen-request-body-name: admin + /api/2.23/admins/api-tokens: + get: + tags: + - Administrators + summary: GET admins/api-tokens + description: Displays API tokens for the specified administrators. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Admin_ids' + - $ref: '#/components/parameters/Admin_names' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Expose_api_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/AdminApiTokenGetResponse' + post: + tags: + - Administrators + summary: POST admins/api-tokens + description: Creates API tokens for the specified administrators. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Admin_ids' + - $ref: '#/components/parameters/Admin_names' + - $ref: '#/components/parameters/Timeout' + 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/AdminApiTokenResponse' + delete: + tags: + - Administrators + summary: DELETE admins/api-tokens + description: Deletes the API tokens of the specified administrators. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Admin_ids' + - $ref: '#/components/parameters/Admin_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.23/admins/cache: + get: + tags: + - Administrators + summary: GET admins/cache + description: List cached administrator information used to determine role based + access control privileges. + parameters: + - $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/Refresh' + - $ref: '#/components/parameters/Sort' + 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/AdminCacheGetResponse' + delete: + tags: + - Administrators + summary: DELETE admins/cache + description: Delete cached administrator role information by name or ID. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/admins/management-access-policies: + get: + tags: + - Policies - Management Access + summary: GET admins/management-access-policies + description: 'List management access policies mapped to admins. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - Management Access + summary: POST admins/management-access-policies + description: Map an admin to a management access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - Management Access + summary: DELETE admins/management-access-policies + description: Remove the mapping of an admin to a management access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/admins/management-authentication-policies: + get: + tags: + - Policies - Management Authentication + summary: GET admins/management-authentication-policies + description: List the members mapped to management authentication 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' + 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/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Management Authentication + summary: POST admins/management-authentication-policies + description: Map a member to a management authentication 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: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextResponse' + delete: + tags: + - Policies - Management Authentication + summary: DELETE admins/management-authentication-policies + description: Remove the management authentication policy mapped to a member. + 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.23/admins/settings: + get: + tags: + - Administrators + summary: List global admin settings + description: Return global admin settings. + parameters: + - $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' + 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/AdminSettingsGetResponse' + patch: + tags: + - Administrators + summary: Update global admin settings + description: Update properties for global admin settings. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminSetting' + required: true + x-codegen-request-body-name: admin-setting + 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/AdminSettingsResponse' + x-codegen-request-body-name: admin-setting + /api/2.23/admins/ssh-certificate-authority-policies: + get: + tags: + - Policies - SSH Certificate Authority + summary: GET admins/ssh-certificate-authority-policies + description: List SSH Certificate Authority policies mapped to specific users. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - SSH Certificate Authority + summary: POST admins/ssh-certificate-authority-policies + description: Map a SSH Certificate Authority policy to a specific user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - SSH Certificate Authority + summary: DELETE admins/ssh-certificate-authority-policies + description: Remove a SSH Certificate Authority policy from a specific user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/alerts: + get: + tags: + - Alerts + summary: GET alerts + description: 'Returns a list of alerts which have been generated by the array. + + + ' + parameters: + - $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' + 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/AlertGetResponse' + patch: + tags: + - Alerts + summary: PATCH alerts + description: 'Make changes to an alert. This is currently limited to the alert''s + `flagged` property. + + + ' + parameters: + - $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: alerts-settings + 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/AlertResponse' + x-codegen-request-body-name: alerts-settings + /api/2.23/alert-watchers: + get: + tags: + - Alert Watchers + summary: GET alert-watchers + description: List alert watchers that are configured to receive alert messages. + parameters: + - $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' + 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/AlertWatcherGetResponse' + post: + tags: + - Alert Watchers + summary: POST alert-watchers + description: Create an alert watcher to receive array alert messages. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AlertWatcherResponse' + x-codegen-request-body-name: alert-watcher + delete: + tags: + - Alert Watchers + summary: DELETE alert-watchers + description: Delete an alert watcher. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Alert Watchers + summary: PATCH alert-watchers + description: "Modify an alert watcher\u2019s configuration. Enable or disable + an alert watcher privilege and select the level of alert notification of an + alert watcher. Alert notification levels are `info`, `warning`, or `critical`." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AlertWatcher' + required: true + x-codegen-request-body-name: alert-watcher + 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/AlertWatcherResponse' + x-codegen-request-body-name: alert-watcher + /api/2.23/alert-watchers/test: + get: + tags: + - Alert Watchers + summary: GET alert-watchers/test + description: Test an alert watcher's contact information to verify alerts can + be sent and received. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + 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/TestResultResponse' + /api/2.23/api-clients: + get: + tags: + - API Clients + summary: GET api-clients + description: List an API client and its configuration attributes. + parameters: + - $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' + responses: + '200': + description: 'Returns a list of API clients. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClientsResponse' + post: + tags: + - API Clients + summary: POST api-clients + description: Create an API client to authorize Access Token or Bearer Tokens + for use on the array. Required fields include `issuer`, `public_key`, and + `access_token_ttl_in_ms`. After creating an API client, it can only be enabled + by an authorized user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClientsPost' + required: true + x-codegen-request-body-name: api-client + responses: + '200': + description: 'Returns the new api-clients. All new api-clients are disabled. + + An authorized party must patch the api-clients to be enabled, which signifies + + the api-clients are now trusted and authorized to issue id tokens for + this + + array. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClientsResponse' + x-codegen-request-body-name: api-client + delete: + tags: + - API Clients + summary: DELETE api-clients + description: Delete the API client. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - API Clients + summary: PATCH api-clients + description: Modify an API client. Newly created API clients can be enabled + by setting the `enabled` parameter to `true`. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClient' + required: true + x-codegen-request-body-name: api-clients + responses: + '200': + description: Returns the patched api-clients. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ApiClientsResponse' + x-codegen-request-body-name: api-clients + /api/2.23/arrays: + get: + tags: + - Arrays + summary: GET arrays + description: List array attributes such as the array name, ID, version, and + NTP servers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayGetResponse' + patch: + tags: + - Arrays + summary: PATCH arrays + description: Modify the general configuration of the array including banner + text, array name, NTP servers, and time zone. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Array' + required: true + x-codegen-request-body-name: array + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayResponse' + x-codegen-request-body-name: array + /api/2.23/arrays/clients/performance: + get: + tags: + - Clients + summary: GET clients-performance + description: List client performance metrics. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Protocol_clients' + - $ref: '#/components/parameters/Sort' + - $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/ClientsPerformanceGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ClientsPerformanceGetResponse' + /api/2.23/arrays/clients/s3-specific-performance: + get: + tags: + - Clients + summary: GET clients-performance + description: List S3 client performance performance metrics. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + - $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/ClientsS3SpecificPerformanceGetResponse' + /api/2.23/arrays/eula: + get: + tags: + - Arrays + summary: GET arrays/eula + description: List the End User Agreement and signature. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/EulaGetResponse' + patch: + tags: + - Arrays + summary: PATCH arrays/eula + description: Modifies the signature on the End User Agreement. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Eula' + required: false + x-codegen-request-body-name: eula + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/EulaResponse' + x-codegen-request-body-name: eula + /api/2.23/arrays/factory-reset-token: + get: + tags: + - Arrays + summary: List factory reset tokens + description: Displays a list of tokens used to perform a factory reset on the + array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayFactoryResetTokenGetResponse' + post: + tags: + - Arrays + summary: Create a factory reset token + description: 'Creates a token that can be used to perform a factory reset on + the array. + + Factory reset tokens can only be created after the array has been prepared + + for reset (e.g., all file systems, buckets, and snapshots must first be eradicated). + + After a token has been created, operations that would take the array out of + + the prepared state (e.g., creating file systems) are disabled until all + + tokens have been deleted. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayFactoryResetTokenResponse' + delete: + tags: + - Arrays + summary: Delete a factory reset token + description: 'Deletes any existing token that could be used to perform a factory + reset on the array. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/arrays/management-authentication-policies: + get: + tags: + - Policies - Management Authentication + summary: GET arrays/management-authentication-policies + description: List management authentication policies mapped as default for admins. + 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' + 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/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Management Authentication + summary: POST arrays/management-authentication-policies + description: Map a management authentication policy as default for admins. + 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/PolicyMemberContextResponse' + delete: + tags: + - Policies - Management Authentication + summary: DELETE arrays/management-authentication-policies + description: Remove a management authentication policy from being a default + for admins. + 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.23/arrays/ssh-certificate-authority-policies: + get: + tags: + - Policies - SSH Certificate Authority + summary: GET admins/settings/ssh-certificate-authority-policies + description: List SSH Certificate Authority policies mapped as defaults for + admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - SSH Certificate Authority + summary: POST admins/settings/ssh-certificate-authority-policies + description: Map a SSH Certificate Authority policy as a default for admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - SSH Certificate Authority + summary: DELETE admins/settings/ssh-certificate-authority-policies + description: Remove a SSH Certificate Authority policy from being a default + for admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/array-connections: + get: + tags: + - Array Connections + summary: GET array-connections + description: List connected arrays for replication. + 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/Offset' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + 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/ArrayConnectionGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayConnectionGetResponse' + post: + tags: + - Array Connections + summary: POST array-connections + description: Create a connection to an array for replication and configure network + settings. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayConnectionResponse' + x-codegen-request-body-name: array-connection + delete: + tags: + - Array Connections + summary: DELETE array-connections + description: Delete a connection to an array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Remote_ids_deprecated' + - $ref: '#/components/parameters/Remote_names_deprecated' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Array Connections + summary: PATCH array-connections + description: Modify the configuration of a connected array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Remote_ids_deprecated' + - $ref: '#/components/parameters/Remote_names_deprecated' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayConnection' + required: true + x-codegen-request-body-name: array-connection + 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/ArrayConnectionResponse' + x-codegen-request-body-name: array-connection + /api/2.23/array-connections/connection-key: + get: + tags: + - Array Connections + summary: GET array-connections/connection-key + description: List connection keys used to authenticate the connection from one + array to another. + parameters: + - $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' + 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/ArrayConnectionKeyGetResponse' + post: + tags: + - Array Connections + summary: POST array-connections/connection-key + description: Create an array connection key allowing one array to connect to + another for replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayConnectionKeyResponse' + /api/2.23/array-connections/path: + get: + tags: + - Array Connections + summary: GET array-connections/path + description: List network path details of connected arrays. + 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/Offset' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + 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/ArrayConnectionPathGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayConnectionPathGetResponse' + /api/2.23/array-connections/performance/replication: + get: + tags: + - Array Connections + summary: GET array-connections/performance/replication + description: List performance metrics of file systems or objects being replicated + from one array to another. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/Total_only' + - $ref: '#/components/parameters/Type_for_performance' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectionRelationshipPerformanceReplicationGetResp' + /api/2.23/arrays/http-specific-performance: + get: + tags: + - Arrays + summary: GET arrays/http-specific-performance + description: List the HTTP performance metrics of the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayHttpSpecificPerformanceGet' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayHttpSpecificPerformanceGet' + /api/2.23/arrays/nfs-specific-performance: + get: + tags: + - Arrays + summary: GET arrays/nfs-specific-performance + description: List the NFS performance metrics of the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayNfsSpecificPerformanceGet' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayNfsSpecificPerformanceGet' + /api/2.23/arrays/performance: + get: + tags: + - Arrays + summary: GET arrays/performance + description: Lists the overall performance metrics of the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Protocol' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayPerformanceGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayPerformanceGetResponse' + /api/2.23/arrays/performance/replication: + get: + tags: + - Arrays + summary: GET arrays/performance/replication + description: List replication performance metrics. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/Type_for_performance' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayPerformanceReplicationGetResp' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayPerformanceReplicationGetResp' + /api/2.23/arrays/s3-specific-performance: + get: + tags: + - Arrays + summary: GET arrays/s3-specific-performance + description: List the S3 performance metrics of the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayS3SpecificPerformanceGetResp' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayS3SpecificPerformanceGetResp' + /api/2.23/arrays/space: + get: + tags: + - Arrays + summary: GET arrays/space + description: List available and used storage space on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/Type' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArraySpaceGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArraySpaceGetResponse' + /api/2.23/arrays/space/storage-classes: + get: + tags: + - Arrays + summary: GET arrays/space/storage-classes + description: List available and used storage space for storage classes on the + array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/StorageClassNames' + - $ref: '#/components/parameters/Total_only' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArraySpaceStorageClassGetResponse' + /api/2.23/arrays/supported-time-zones: + get: + tags: + - Arrays + summary: GET arrays/supported-time-zones + description: List supported time zones for the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ArraysSupportedTimeZonesGetResponse' + /api/2.23/arrays/erasures: + post: + summary: Create a process for factory reset + description: 'Creates the initiation of the factory reset process. + + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Eradicate_all_data_required' + - $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' + tags: + - Arrays + patch: + summary: Factory reset - finalize + description: 'After the process has been completed, we need to finalize the + factory reset process. + + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Delete_sanitization_certificate_required' + - $ref: '#/components/parameters/Eradicate_all_data_required' + - $ref: '#/components/parameters/Finalize_array_erasure_required' + responses: + 200: + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayErasureResponse' + tags: + - Arrays + get: + summary: Get factory reset status + description: 'Get the factory reset process status. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + 200: + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayErasureGetResponse' + tags: + - Arrays + delete: + summary: Stop factory reset + description: 'Stops the factory reset process when it is `failed`. + + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + 200: + description: OK + tags: + - Arrays + /api/2.23/audits: + get: + tags: + - Audits + summary: GET audits + description: List the array audit trail to view activities that were performed + on the array. + parameters: + - $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' + 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/AuditGetResponse' + /api/2.23/audit-file-systems-policies: + get: + tags: + - Policies - Audit for File Systems + summary: GET audit-file-systems-policies + description: Displays a list of audit policies for file systems. + 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' + 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/AuditFileSystemsPoliciesGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AuditFileSystemsPoliciesGetResponse' + post: + tags: + - Policies - Audit for File Systems + summary: POST audit-file-systems-policies + description: Create a new audit policy for file systems. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuditFileSystemsPoliciesPost' + required: false + x-codegen-request-body-name: policy + 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/AuditFileSystemsPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Audit for File Systems + summary: DELETE audit-file-systems-policies + description: Delete one or more audit policies. + 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: + - Policies - Audit for File Systems + summary: PATCH audit-file-systems-policies + description: Modify an existing audit policy's attributes. + 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/AuditFileSystemsPoliciesPatch' + required: true + x-codegen-request-body-name: policy + 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/AuditFileSystemsPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/audit-file-systems-policies/members: + get: + tags: + - Policies - Audit for File Systems + summary: GET audit-file-systems-policies/members + description: List file systems mapped to a audit policy. + 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' + 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/AuditFileSystemsPoliciesMembersGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AuditFileSystemsPoliciesMembersGetResponse' + post: + tags: + - Policies - Audit for File Systems + summary: POST audit-file-systems-policies/members + description: Map a file system to a audit 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: + application/json: + schema: + $ref: '#/components/schemas/AuditFileSystemsPoliciesMembersResponse' + delete: + tags: + - Policies - Audit for File Systems + summary: DELETE audit-file-systems-policies/members + description: Remove the audit policy mapped to a file system. + 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.23/audit-file-systems-policy-operations: + get: + tags: + - Policies - Audit for File Systems + summary: GET audit-file-systems-policy-operations + description: 'List of valid strings for audit policy rules for file systems. + + Each string is either a valid operation or our custom group of operations + (`ReadOnly`, `WriteOnly`). + + Each of the operations, when included in a rule, will audit the operation + on the file system. + + + ' + 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' + 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/AuditFileSystemsPolicyOperationGetResponse' + /api/2.23/audit-object-store-policies: + get: + tags: + - Policies - Audit for Object Store + summary: GET audit-object-store-policies + description: Displays a list of audit policies for objects. + 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' + 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/AuditObjectStorePoliciesGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AuditObjectStorePoliciesGetResponse' + post: + tags: + - Policies - Audit for Object Store + summary: POST audit-object-store-policies + description: Create a new audit policy for objects. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuditObjectStorePoliciesPost' + required: false + x-codegen-request-body-name: policy + 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/AuditObjectStorePoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Audit for Object Store + summary: DELETE audit-object-store-policies + description: Delete one or more audit policies. + 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: + - Policies - Audit for Object Store + summary: PATCH audit-object-store-policies + description: Modify an existing audit policy's attributes. + 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/AuditObjectStorePoliciesPatch' + required: true + x-codegen-request-body-name: policy + 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/AuditObjectStorePoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/audit-object-store-policies/members: + get: + tags: + - Policies - Audit for Object Store + summary: GET audit-object-store-policies/members + description: List source(bucket/account) mapped to an audit object policy. + 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' + 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/AuditObjectStorePoliciesMembersGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AuditObjectStorePoliciesMembersGetResponse' + post: + tags: + - Policies - Audit for Object Store + summary: POST audit-object-store-policies/members + description: Map a source(bucket/account) to an audit object 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: + application/json: + schema: + $ref: '#/components/schemas/AuditObjectStorePoliciesMembersResponse' + delete: + tags: + - Policies - Audit for Object Store + summary: DELETE audit-object-store-policies/members + description: Remove the audit object policy mapped to a source(bucket/account). + 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.23/blades: + get: + tags: + - Blades + summary: GET blades + description: List array blade information. + parameters: + - $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_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/BladeGetResponse' + /api/2.23/bucket-audit-filter-actions: + get: + tags: + - Buckets + summary: GET bucket-audit-filter-actions + description: 'List valid actions for bucket audit filter. Each action is either + a valid + + AWS S3 action (prefixed by `s3:`), special wildcard action (`s3:*`), or our + + custom group of actions (`s3:ReadOnly`, `s3:WriteOnly`). Each action, when + + included in a rule, may audit the action on the bucket. + + + ' + 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' + 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/BucketAuditFilterActionGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAuditFilterActionGetResponse' + /api/2.23/buckets: + get: + tags: + - Buckets + summary: 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_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. + + ' + 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' + post: + tags: + - Buckets + summary: 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/BucketPost' + 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: 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: PATCH buckets + description: Modify object store bucket attributes such as destroyed and versioning. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Cancel_storage_class_transition' + - $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/BucketPatch' + 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.23/buckets/audit-filters: + get: + tags: + - Buckets + summary: GET buckets/audit-filters + description: 'List audit filters associated with the specified bucket. + + ' + 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/BucketAuditFilterGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAuditFilterGetResponse' + post: + tags: + - Buckets + summary: POST buckets/audit-filters + description: 'Create a new audit filter for the specified bucket. + + `names` query parameter is required. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAuditFilterPost' + required: true + x-codegen-request-body-name: audit filter + 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/BucketAuditFilterResponse' + x-codegen-request-body-name: audit filter + delete: + tags: + - Buckets + summary: DELETE buckets/audit-filters + description: 'Delete one or more audit filters associated with the specified + bucket. + + `names` query parameter is required. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $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: PATCH buckets/audit-filters + description: 'Modify the audit filter associated with the specified bucket. + + `names` query parameter is required. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAuditFilterPost' + required: true + x-codegen-request-body-name: audit filter + 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/BucketAuditFilterResponse' + x-codegen-request-body-name: audit filter + /api/2.23/buckets/cross-origin-resource-sharing-policies: + get: + tags: + - Buckets + summary: GET buckets/cross-origin-resource-sharing-policies + description: 'List cross origin resource sharing policy for the specified bucket + and its attributes. + + Either `names` or `bucket_names`/`bucket_ids` query parameters can be used. + + ' + 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/CrossOriginResourceSharingPolicyGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyGetResponse' + post: + tags: + - Buckets + summary: POST buckets/cross-origin-resource-sharing-policies + description: 'Create a new cross origin resource sharing policy for the specified + bucket. + + Policy''s name will be autogenerated by the system. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyPatch' + required: false + x-codegen-request-body-name: policy + 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/CrossOriginResourceSharingPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Buckets + summary: DELETE buckets/cross-origin-resource-sharing-policies + description: 'Delete a cross origin resource sharing policy of the specified + bucket. + + Either `names` or `bucket_names`/`bucket_ids` query parameters can be used. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $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.23/buckets/cross-origin-resource-sharing-policies/rules: + get: + tags: + - Buckets + summary: GET buckets/cross-origin-resource-sharing-policies/rules + description: 'List cross origin resource sharing policy rules for the specified + bucket and their attributes. + + Either `policy_names` or `bucket_names` query parameters can be used. + + ' + 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/CrossOriginResourceSharingPolicyRuleGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleGetResponse' + post: + tags: + - Buckets + summary: POST buckets/cross-origin-resource-sharing-policies/rules + description: 'Create a new cross origin resource sharing policy rule for the + specified bucket. + + Either `policy_names` or `bucket_names` query parameters can be used. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRulePost' + 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/CrossOriginResourceSharingPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Buckets + summary: DELETE buckets/cross-origin-resource-sharing-policies/rules + description: 'Delete one or more cross origin resource sharing policy rules + for the specified bucket. + + Either `policy_names` or `bucket_names` query parameters can be used. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names' + - $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.23/buckets/performance: + get: + tags: + - Buckets + summary: GET buckets/performance + description: List performance metrics for a bucket. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/BucketPerformanceGetResponse' + /api/2.23/buckets/bucket-access-policies: + get: + tags: + - Buckets + summary: GET buckets/bucket-access-policies + description: 'List a policy for the specified bucket and its attributes. Either + `names` or + + `bucket_names`/`bucket_ids` query parameters can be used. + + ' + 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/BucketAccessPolicyGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessPolicyGetResponse' + post: + tags: + - Buckets + summary: POST buckets/bucket-access-policies + description: 'Create a new policy for the specified bucket. Policy''s name will + be autogenerated + + by the system. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessPolicyPost' + required: false + x-codegen-request-body-name: policy + 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/BucketAccessPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Buckets + summary: DELETE buckets/bucket-access-policies + description: 'Delete a bucket policy of the specified bucket. Either `names` + or `bucket_names`/`bucket_ids` + + query parameters can be used. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $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.23/buckets/bucket-access-policies/rules: + get: + tags: + - Buckets + summary: GET buckets/bucket-access-policies/rules + description: 'List bucket policy rules for the specified bucket and their attributes. + Either `policy_names` + + or `bucket_names`/`bucket_ids` query parameters can be used. + + ' + 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/BucketAccessPolicyRuleGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessPolicyRuleGetResponse' + post: + tags: + - Buckets + summary: POST buckets/bucket-access-policies/rules + description: 'Create a new bucket policy rule for the specified bucket. Either + `policy_names` + + or `bucket_names`/`bucket_ids` query parameters can be used. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketAccessPolicyRulePost' + 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/BucketAccessPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Buckets + summary: DELETE buckets/bucket-access-policies/rules + description: 'Delete one or more bucket policy rules for the specified bucket. + Either `policy_names` + + or `bucket_names`/`bucket_ids` query parameters can be used. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Bucket_ids' + - $ref: '#/components/parameters/Bucket_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names' + - $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.23/buckets/s3-specific-performance: + get: + tags: + - Buckets + summary: GET buckets/s3-specific-performance + description: List performance metrics specific to S3 operations for a bucket. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/BucketS3SpecificPerformanceGetResp' + /api/2.23/bucket-replica-links: + get: + tags: + - Bucket Replica Links + summary: GET bucket-replica-links + description: List bucket replica links for object replication. + 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/Local_bucket_ids' + - $ref: '#/components/parameters/Local_bucket_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Remote_bucket_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + - $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/BucketReplicaLinkGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BucketReplicaLinkGetResponse' + post: + tags: + - Bucket Replica Links + summary: POST bucket-replica-links + description: Create a bucket replica link for object replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Local_bucket_ids' + - $ref: '#/components/parameters/Local_bucket_names' + - $ref: '#/components/parameters/Remote_bucket_names' + - $ref: '#/components/parameters/Remote_credentials_ids' + - $ref: '#/components/parameters/Remote_credentials_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketReplicaLinkPost' + required: true + x-codegen-request-body-name: bucket-replica-link + 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/BucketReplicaLinkResponse' + x-codegen-request-body-name: bucket-replica-link + delete: + tags: + - Bucket Replica Links + summary: DELETE bucket-replica-links + description: Delete a bucket replica link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_bucket_ids' + - $ref: '#/components/parameters/Local_bucket_names' + - $ref: '#/components/parameters/Remote_bucket_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_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: + - Bucket Replica Links + summary: PATCH bucket-replica-links + description: Modify the configuration of a bucket replica link including whether + the link is paused and the object store remote credentials used. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_bucket_ids' + - $ref: '#/components/parameters/Local_bucket_names' + - $ref: '#/components/parameters/Remote_bucket_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BucketReplicaLink' + required: true + x-codegen-request-body-name: bucket-replica-link + 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/BucketReplicaLinkResponse' + x-codegen-request-body-name: bucket-replica-link + /api/2.23/certificates: + get: + tags: + - Certificates + summary: GET certificates + description: List array certificates and their attributes. + parameters: + - $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' + 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/CertificateGetResponse' + post: + tags: + - Certificates + summary: POST certificates + description: 'Either upload a CA certificate to the array, upload a new appliance + certificate with + + a private key, or generate a new self-signed certificate with a new private + key and + + the specified attributes. + + ' + parameters: + - $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: 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/CertificateResponse' + x-codegen-request-body-name: certificate + delete: + tags: + - Certificates + summary: DELETE certificates + description: Delete a CA certificate from the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Certificates + summary: PATCH certificates + description: 'Modify SSL certificate attributes such as importing a new certificate + + and private key, or change intermediate certificate chains. + + Alternatively, generate a new self-signed certificate with specified properties + + to overwrite an existing certificate, and optionally generate a new private + key. + + ' + parameters: + - $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/CertificatePatch' + required: true + x-codegen-request-body-name: certificate + 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/CertificateResponse' + x-codegen-request-body-name: certificate + /api/2.23/certificates/certificate-groups: + get: + tags: + - Certificates + summary: GET certificates/certificate-groups + description: List membership associations between groups and certificates. + parameters: + - $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' + 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/CertificateCertificateGroupGetResp' + post: + tags: + - Certificates + summary: POST certificates/certificate-groups + description: Add one or more certificates to one or more certificate groups. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateCertificateGroupResponse' + delete: + tags: + - Certificates + summary: DELETE certificates/certificate-groups + description: Remove one or more certificates from one or more certificate groups. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/certificates/certificate-signing-requests: + post: + tags: + - Certificates + summary: Create certificate-signing-requests + description: 'Creates a certificate signing request using a specified certificate + and parameters. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateSigningRequestPost' + required: true + x-codegen-request-body-name: certificate + 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/CertificateSigningRequestResponse' + x-codegen-request-body-name: certificate + /api/2.23/certificates/uses: + get: + tags: + - Certificates + summary: GET certificates/uses + description: List how certificates are being used and by what. + parameters: + - $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' + 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/CertificateUseGetResponse' + /api/2.23/certificate-groups: + get: + tags: + - Certificate Groups + summary: GET certificate-groups + description: Display all array certificate groups. + parameters: + - $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' + 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/CertificateGroupGetResponse' + post: + tags: + - Certificate Groups + summary: POST certificate-groups + description: Create one or more certificate groups on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/json: + schema: + $ref: '#/components/schemas/CertificateGroupResponse' + delete: + tags: + - Certificate Groups + summary: DELETE certificate-groups + description: Delete one or more certificate groups from the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/certificate-groups/certificates: + get: + tags: + - Certificate Groups + summary: GET certificate-groups/certificates + description: List membership associations between groups and certificates on + the array. + parameters: + - $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' + 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/CertificateGroupCertificateGetResp' + post: + tags: + - Certificate Groups + summary: POST certificate-groups/certificates + description: Add one or more certificates to one or more certificate groups + on the array. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateGroupCertificateResponse' + delete: + tags: + - Certificate Groups + summary: DELETE certificate-groups/certificates + description: Delete one or more certificate groups. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/certificate-groups/uses: + get: + tags: + - Certificate Groups + summary: GET certificate-groups/uses + description: List how certificate groups are being used and by what. + parameters: + - $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' + 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/CertificateGroupUseGetResponse' + /api/2.23/data-eviction-policies: + get: + tags: + - Policies - Data Eviction + summary: GET data-eviction-policies + description: List data eviction 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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/DataEvictionPoliciesGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataEvictionPoliciesGetResponse' + post: + tags: + - Policies - Data Eviction + summary: POST data-eviction-policies + description: Create a data eviction policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DataEvictionPolicyPost' + required: true + x-codegen-request-body-name: policy + 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/DataEvictionPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Data Eviction + summary: DELETE data-eviction-policies + description: Delete a data eviction policy. + 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: + - Policies - Data Eviction + summary: PATCH data-eviction-policies + description: Modify a data eviction policy. + 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/DataEvictionPolicy' + required: false + x-codegen-request-body-name: policy + 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/DataEvictionPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/data-eviction-policies/file-systems: + get: + summary: GET data-eviction-policies/file-systems + description: Lists file systems mapped to a data eviction policy. + 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' + 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/DataEvictionPoliciesMembersGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataEvictionPoliciesMembersGetResponse' + tags: + - Policies - Data Eviction + post: + summary: POST data-eviction-policies/file-systems + description: Maps a data eviction policy to a file system. + 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/DataEvictionPoliciesMembersResponse' + tags: + - Policies - Data Eviction + delete: + summary: DELETE data-eviction-policies/file-systems + description: Removes the data eviction policy mapped to a file system. + 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 + tags: + - Policies - Data Eviction + /api/2.23/data-eviction-policies/members: + get: + tags: + - Policies - Data Eviction + summary: GET data-eviction-policies/members + description: Lists file systems mapped to a data eviction policy. + 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' + 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/DataEvictionPoliciesMembersGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataEvictionPoliciesMembersGetResponse' + /api/2.23/directory-services: + get: + tags: + - Directory Services + summary: GET directory-services + description: List directory service configuration information. + parameters: + - $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' + 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/DirectoryServiceGetResponse' + patch: + tags: + - Directory Services + summary: PATCH directory-services + description: 'Modifies and tests the directory service configuration. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DirectoryService' + required: true + x-codegen-request-body-name: directory-service + 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/DirectoryServiceResponse' + x-codegen-request-body-name: directory-service + /api/2.23/directory-services/roles: + get: + tags: + - Directory Services + summary: GET directory-service/roles + description: 'Return array''s RBAC group configuration settings for manageability. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids_for_directory_service_roles' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names_for_directory_service_roles' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Role_ids' + - $ref: '#/components/parameters/Role_names' + - $ref: '#/components/parameters/Sort' + 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/DirectoryServiceRolesGetResponse' + post: + tags: + - Directory Services + summary: POST directory-service/roles + description: 'Create an RBAC group configuration setting for manageability. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DirectoryServiceRolePost' + required: true + x-codegen-request-body-name: directory-service-roles + responses: + '200': + description: Returns the newly created directory-service-role object. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DirectoryServiceRolesResponse' + x-codegen-request-body-name: directory-service-roles + delete: + tags: + - Directory Services + summary: DELETE directory-service/roles + description: 'Delete an RBAC group configuration setting for manageability. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Directory Services + summary: PATCH directory-service/roles + description: 'Update an RBAC group configuration setting for manageability. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids_for_directory_service_roles' + - $ref: '#/components/parameters/Names_for_directory_service_roles' + - $ref: '#/components/parameters/Role_ids' + - $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: Returns the newly updated directory-service-role object. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DirectoryServiceRolesResponse' + x-codegen-request-body-name: directory-service-roles + /api/2.23/directory-services/roles/management-access-policies: + get: + tags: + - Policies - Management Access + summary: GET directory-services/roles/management-access-policies + description: 'List management access policies mapped to directory service group + mappings. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - Management Access + summary: POST directory-services/roles/management-access-policies + description: Map a directory service group to a management access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - Management Access + summary: DELETE directory-services/roles/management-access-policies + description: Remove the mapping of a directory service group to a management + access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/directory-services/test: + get: + tags: + - Directory Services + summary: GET directory-services/test + description: Test the configured directory services on the array. + 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/Sort' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/TestResultRemoteExecutionGet' + '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/TestResultRemoteExecutionGet' + patch: + tags: + - Directory Services + summary: PATCH directory-service/test + description: Test the configured directory services on the array. Optionally, + provide modifications which will be used to perform the tests, but will not + be applied to the current configuration. + parameters: + - $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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + requestBody: + description: 'An optional directory service configuration that, if provided, + + will be used to overwrite aspects of the existing directory service + + objects when performing tests. + + ' + content: + application/json: + schema: + $ref: '#/components/schemas/DirectoryService' + required: false + x-codegen-request-body-name: directory-service + 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/TestResultRemoteExecution' + x-codegen-request-body-name: directory-service + /api/2.23/dns: + get: + tags: + - DNS + summary: GET dns + 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/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' + 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/DnsGetResponse' + post: + tags: + - DNS + summary: POST dns + 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/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DnsPost' + required: true + x-codegen-request-body-name: dns + 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/DnsResponse' + x-codegen-request-body-name: dns + delete: + tags: + - DNS + summary: DELETE dns + description: 'Deletes a DNS configuration. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + responses: + '200': + description: OK + content: {} + patch: + tags: + - DNS + summary: PATCH dns + description: Modify a DNS configuration. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Dns' + required: true + x-codegen-request-body-name: dns + 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/DnsResponse' + x-codegen-request-body-name: dns + /api/2.23/drives: + get: + tags: + - Drives + summary: GET drives + description: List array drive information. + parameters: + - $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_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/DriveGetResponse' + /api/2.23/file-systems: + get: + tags: + - File Systems + summary: GET file-systems + description: List one or more file systems on the array. + 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_only' + - $ref: '#/components/parameters/Workload_ids' + - $ref: '#/components/parameters/Workload_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/FileSystemGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemGetResponse' + post: + tags: + - File Systems + summary: POST file-systems + description: Create a file system on the current array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Default_exports' + - $ref: '#/components/parameters/Discard_non_snapshotted_data' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Overwrite' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemPost' + required: true + x-codegen-request-body-name: file-system + 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/FileSystemResponse' + x-codegen-request-body-name: file-system + delete: + tags: + - File Systems + summary: DELETE file-systems + description: Deletes a file system. Deleting a file system is equivalent to + eradication. A file system's `destroyed` parameter must be set to `true` before + a file system can be deleted. + 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: + - File Systems + summary: PATCH file-systems + description: Modify a file system's attributes including its export protocols + and limits. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Cancel_storage_class_transition' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Delete_link_on_eradication' + - $ref: '#/components/parameters/Discard_detailed_permissions' + - $ref: '#/components/parameters/Discard_non_snapshotted_data' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Ignore_usage' + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemResponse' + x-codegen-request-body-name: file-system + /api/2.23/file-systems/data-eviction-policies: + get: + summary: GET file-systems/data-eviction-policies + description: Lists file systems mapped to a data eviction policy. + 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' + 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/DataEvictionPoliciesMembersGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/DataEvictionPoliciesMembersGetResponse' + tags: + - File Systems + post: + summary: POST file-systems/data-eviction-policies + description: Maps a data eviction policy to a file system. + 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/DataEvictionPoliciesMembersResponse' + tags: + - File Systems + delete: + summary: DELETE file-systems/data-eviction-policies + description: Removes the data eviction policy mapped to a file system. + 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: {} + tags: + - File Systems + /api/2.23/file-systems/groups/performance: + get: + tags: + - File Systems + summary: GET file-systems/groups/performance + description: "List a group\u2019s I/O performance metrics on a file system." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Gids_not_strict' + - $ref: '#/components/parameters/Group_names_not_strict' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + - $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/FileSystemGroupsPerformanceGetResponse' + /api/2.23/file-systems/performance: + get: + tags: + - File Systems + summary: GET file-systems/performance + description: Displays the performance metrics for a file system. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Protocol' + - $ref: '#/components/parameters/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/FileSystemPerformanceGetResponse' + /api/2.23/file-systems/audit-policies: + get: + tags: + - File Systems + summary: GET file-systems/audit-policies + description: List file systems mapped to a audit policy. + 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' + 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/AuditFileSystemsPoliciesMembersGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/AuditFileSystemsPoliciesMembersGetResponse' + post: + tags: + - File Systems + summary: POST file-systems/audit-policies + description: Map a audit policy to a file system. + 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/AuditFileSystemsPoliciesMembersResponse' + delete: + tags: + - File Systems + summary: DELETE file-systems/audit-policies + description: Remove the audit policy mapped to a file system. + 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.23/file-systems/policies: + get: + tags: + - File Systems + summary: GET file-systems/policies + description: 'List file system snapshot scheduling policies. + + Note: if more than 150,000 items would be returned in the response, an error + will be thrown + + and query parameters must be used to limit the items queried. + + ' + 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' + 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/PolicyMemberContextGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - File Systems + summary: POST file-systems/policies + description: Apply a snapshot scheduling policy to a file system. Only one file + system can be mapped to a policy at a time. + 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/PolicyMemberContextResponse' + delete: + tags: + - File Systems + summary: DELETE file-systems/policies + description: Remove a snapshot scheduling policy from a file system. + 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.23/file-systems/policies-all: + get: + tags: + - File Systems + summary: GET file-systems/policies-all + description: 'List file system policies. + + Note: if more than 150,000 items would be returned in the response, an error + will be thrown + + and query parameters must be used to limit the items queried. + + ' + 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' + 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/PolicyMemberContextGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + /api/2.23/file-systems/users/performance: + get: + tags: + - File Systems + summary: GET file-systems/users/performance + description: "List a user\u2019s I/O performance metrics on a file system." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Total_only' + - $ref: '#/components/parameters/Uids_not_strict' + - $ref: '#/components/parameters/User_names_not_strict' + 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/FileSystemUsersPerformanceGetResponse' + /api/2.23/file-systems/worm-data-policies: + get: + tags: + - File Systems + summary: GET file-systems/worm-data-policies + description: List file systems mapped to a WORM data policy. + 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' + 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/WormDataPoliciesMembersGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/WormDataPoliciesMembersGetResponse' + /api/2.23/file-system-exports: + get: + tags: + - File System Exports + summary: GET file-system-exports + description: List one or more file system exports. + 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/Workload_ids' + - $ref: '#/components/parameters/Workload_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/FileSystemExportGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemExportGetResponse' + post: + tags: + - File System Exports + summary: POST file-system-exports + description: Create a file system export. + 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemExportPost' + required: true + x-codegen-request-body-name: file-system-export + 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/FileSystemExportResponse' + x-codegen-request-body-name: file-system-export + delete: + tags: + - File System Exports + summary: DELETE file-system-exports + description: Deletes a file system export. + 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: + - File System Exports + summary: PATCH file-system-exports + description: "Modify a file system export\u2019s attributes." + 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/FileSystemExportPatch' + required: true + x-codegen-request-body-name: file-system-export + 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/FileSystemExportResponse' + x-codegen-request-body-name: file-system-export + /api/2.23/file-system-replica-links: + get: + tags: + - File System Replica Links + summary: GET file-system-replica-links + description: List file system replication link. + 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/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + 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/FileSystemReplicaLinkGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemReplicaLinkGetResponse' + post: + tags: + - File System Replica Links + summary: POST file-system-replica-links + description: Create a file system replication link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemReplicaLink' + required: true + x-codegen-request-body-name: file-system-replica-link + 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/FileSystemReplicaLinkResponse' + x-codegen-request-body-name: file-system-replica-link + delete: + tags: + - File System Replica Links + summary: DELETE file-system-replica-links + description: Delete a file system replication link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Cancel_in_progress_transfers' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_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: + - File System Replica Links + summary: PATCH file-system-replica-links + description: Update a file system replication link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Replicate_now' + 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/FileSystemReplicaLinkResponse' + /api/2.23/file-system-replica-links/policies: + get: + tags: + - File System Replica Links + summary: GET file-system-replica-links/policies + description: List file system replication link 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/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + 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/PolicyMemberWithRemoteGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberWithRemoteGetResponse' + post: + tags: + - File System Replica Links + summary: POST file-system-replica-links/policies + description: Add a policy to a file system replication link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_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/PolicyMemberWithRemoteResponse' + delete: + tags: + - File System Replica Links + summary: DELETE file-system-replica-links/policies + description: Remove a policy from a file system replication link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_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.23/file-system-replica-links/transfer: + get: + tags: + - File System Replica Links + summary: GET file-system-replica-links/transfer + description: List the transfer status details for file system replication. + 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_or_owner_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + - $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/FileSystemSnapshotGetTransferResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSnapshotGetTransferResponse' + /api/2.23/file-system-snapshots: + get: + tags: + - File System Snapshots + summary: GET file-system-snapshots + description: 'List file system snapshots. + + Note: if more than 150,000 items would be returned in the response, an error + will be thrown + + and query parameters must be used to limit the items queried. + + ' + 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_or_owner_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Owner_ids' + - $ref: '#/components/parameters/Sort' + - $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/FileSystemSnapshotGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSnapshotGetResponse' + post: + tags: + - File System Snapshots + summary: POST file-system-snapshots + description: Create a snapshot for a specified source file system. If a source + file system is not specified, creates snapshots for all file systems on the + array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Send' + - $ref: '#/components/parameters/Source_ids' + - $ref: '#/components/parameters/Source_names' + - $ref: '#/components/parameters/Targets' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSnapshotPost' + required: false + x-codegen-request-body-name: file-system-snapshot + 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/FileSystemSnapshotResponse' + x-codegen-request-body-name: file-system-snapshot + delete: + tags: + - File System Snapshots + summary: DELETE file-system-snapshots + description: Delete a file system snapshot. + 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: + - File System Snapshots + summary: PATCH file-system-snapshots + description: Modify file system snapshot attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Latest_replica' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSnapshot' + required: true + x-codegen-request-body-name: file-system-snapshot + 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/FileSystemSnapshotResponse' + x-codegen-request-body-name: file-system-snapshot + /api/2.23/file-system-snapshots/policies: + get: + tags: + - File System Snapshots + summary: GET file-system-snapshots/policies + description: 'List file system snapshots mapped to snapshot scheduling policies. + + Note: if more than 150,000 items would be returned in the response, an error + will be thrown + + and query parameters must be used to limit the items queried. + + ' + 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' + 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/PolicyFileSystemSnapshotGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyFileSystemSnapshotGetResponse' + delete: + tags: + - File System Snapshots + summary: DELETE file-system-snapshots/policies + description: Remove snapshot scheduling policies from a file system. + 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.23/file-system-snapshots/transfer: + get: + tags: + - File System Snapshots + summary: GET file-system-snapshots/transfer + description: 'List file system snapshot transfers from the source array to the + target array. + + Note: if more than 150,000 items would be returned in the response, an error + will be thrown + + and query parameters must be used to limit the items queried. + + ' + 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_or_owner_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + - $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/FileSystemSnapshotGetTransferResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSnapshotGetTransferResponse' + delete: + tags: + - File System Snapshots + summary: DELETE file-system-snapshots/transfer + description: Delete file system snapshot transfers from the source array to + the target array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_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.23/file-systems/locks: + get: + tags: + - File Systems + summary: Get a list of active file locks + description: 'Lists all active file locks that satisfy the conditions specified + by the + + parameters. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Client_names' + - $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/Inodes' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Paths' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/FileLockGetResponse' + delete: + tags: + - File Systems + summary: Invalidate file locks + description: 'Invalidates file locks. It can be used to either delete an individual + lock + + by name or multiple locks filtered by parameters. E.g. to delete locks held + + by a client on specific file, parameters `client_names`, `file_system_ids` + or + + `file_system_names` and `path` must be specified. + + When `names` is specified, no other query parameter can be specified. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Client_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Inodes' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Paths' + - $ref: '#/components/parameters/Recursive' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/file-systems/locks/clients: + get: + tags: + - File Systems + summary: Get a list of clients that hold active file locks + description: Lists all clients that hold active file locks. + 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' + 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/FileSystemClientsGetResponse' + /api/2.23/file-systems/locks/nlm-reclamations: + post: + tags: + - File Systems + summary: Initiate NLM reclamation. + description: 'NLM reclamation is a system-wide operation, affecting all clients, + and 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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileLockNlmReclamationResponse' + /api/2.23/file-systems/sessions: + get: + tags: + - File Systems + summary: Get a list of active sessions + description: 'Lists all active sessions that satisfy the conditions specified + by the + + parameters. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Client_names' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Protocols' + - $ref: '#/components/parameters/Sessions_user_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/FileSessionGetResponse' + delete: + tags: + - File Systems + summary: Delete sessions + description: 'Delete sessions. It can be used to either delete an individual + session + + by name or multiple sessions filtered by parameters. E.g. to delete SMBv3 + + sessions held by specific client, `protocols` and `client_names` must be + + specified. + + To prevent accidental deletes, setting flag `disruptive` to `true` + + is required when only a single query parameter is part of the query. + + E.g. to delete all SMBv3 sessions, query parameters `protocols` and + + `disruptive` must be set. + + When `names` is specified, no other query parameter can be specified. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Client_names' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Disruptive' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Protocols' + - $ref: '#/components/parameters/Sessions_user_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.23/file-systems/space/storage-classes: + get: + tags: + - File Systems + summary: GET file-systems/space/storage-classes + description: List available and used storage space per filesystem. + parameters: + - $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/StorageClassNames' + - $ref: '#/components/parameters/Total_only' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FileSystemSpaceStorageClassGetResponse' + /api/2.23/file-systems/open-files: + get: + tags: + - File Systems + summary: GET file-systems/open-files + description: List open files. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Client_names' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Open_files_paths' + - $ref: '#/components/parameters/Protocols_required' + - $ref: '#/components/parameters/Session_names' + - $ref: '#/components/parameters/Open_files_user_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/FileSystemOpenFilesGetResponse' + delete: + tags: + - File Systems + summary: DELETE file-systems/open-files + description: Close open file from given identifiers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/fleets: + get: + tags: + - Fleets + summary: GET fleets + description: Displays information about the fleets known to the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids_single' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names_single' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + - $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/FleetGetResponse' + post: + tags: + - Fleets + summary: POST fleets + 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/XRequestId' + - $ref: '#/components/parameters/Names_single' + 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/FleetResponse' + delete: + tags: + - Fleets + summary: DELETE Fleets + description: 'Permanently delete a fleet. A fleet can only be deleted if the + current array is the only array + + in the fleet. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids_single' + - $ref: '#/components/parameters/Names_single' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Fleets + summary: PATCH fleets + description: 'Rename a fleet 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/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.23/fleets/fleet-key: + get: + tags: + - Fleets + summary: GET fleet-key + description: 'Displays the time remaining on the fleet key. + + Note: fleet key itself is not displayed, since that is only available at the + time of fleet key + + creation. + + ' + parameters: + - $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_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/FleetKeyGetResponse' + post: + tags: + - Fleets + summary: POST 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/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FleetKeyResponse' + /api/2.23/fleets/members: + get: + tags: + - Fleets + summary: GET fleet members + description: Displays the members in the current fleet. + parameters: + - $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_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/FleetMemberGetResponse' + post: + tags: + - Fleets + summary: POST fleets + 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/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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/FleetMemberResponse' + x-codegen-request-body-name: members + delete: + tags: + - Fleets + summary: Remove fleet members + description: 'Remove 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/XRequestId' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Member_names' + - $ref: '#/components/parameters/Unreachable' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/hardware: + get: + tags: + - Hardware + summary: GET hardware + description: List hardware slots and bays and the status of installed components. + parameters: + - $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' + 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/HardwareGetResponse' + patch: + tags: + - Hardware + summary: PATCH hardware + description: 'Controls the visual identification light of the specified hardware + component. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Hardware' + required: true + x-codegen-request-body-name: hardware + 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/HardwareResponse' + x-codegen-request-body-name: hardware + /api/2.23/hardware-connectors: + get: + tags: + - Hardware Connectors + summary: GET hardware-connectors + description: 'The endpoint is deprecated. Use the `/network-interfaces/connectors` + endpoint instead. + + List array connection information. + + ' + parameters: + - $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' + 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/HardwareConnectorGetResponse' + patch: + tags: + - Hardware Connectors + summary: PATCH hardware-connectors + description: 'The endpoint is deprecated. Use the `/network-interfaces/connectors` + endpoint instead. + + Modify array connection information. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HardwareConnector' + required: true + x-codegen-request-body-name: hardware-connector + 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/HardwareConnectorResponse' + x-codegen-request-body-name: hardware-connector + /api/2.23/hardware-connectors/performance: + get: + tags: + - Hardware Connectors + summary: GET hardware-connectors/performance + description: 'The endpoint is deprecated. Use the `/network-interfaces/connectors/performance` + + endpoint instead. + + Displays network statistics, historical bandwidth, and error reporting for + + all specified hardware connectors. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/HardwareConnectorPerformanceGetResponse' + /api/2.23/keytabs: + get: + tags: + - Keytabs + summary: GET keytabs + description: List a Kerberos keytab file and its configuration information. + parameters: + - $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' + 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/KeytabGetResponse' + post: + tags: + - Keytabs + summary: POST keytabs + description: Import a Kerberos keytab file from a Key Distribution Center. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Name_prefixes' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KeytabPost' + required: true + x-codegen-request-body-name: keytab + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/KeytabResponse' + x-codegen-request-body-name: keytab + delete: + tags: + - Keytabs + summary: DELETE keytabs + description: Delete a Kerberos keytab file. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/keytabs/download: + get: + tags: + - Keytabs + summary: GET keytabs/download + description: Download a Kerberos keytab file. The file can be downloaded in + the native binary format or a base64 encoded format. If not specified, defaults + to binary. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Keytab_ids' + - $ref: '#/components/parameters/Keytab_names' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/octet-stream: + schema: + $ref: '#/components/schemas/KeytabFileResponse' + text/plain: + schema: + $ref: '#/components/schemas/KeytabFileResponse' + /api/2.23/keytabs/upload: + post: + tags: + - Keytabs + summary: POST keytabs/upload + description: Upload a Kerberos keytab file to the array. The file can be uploaded + in the native binary format or a base64 encoded format. If not specified, + defaults to binary. The procedure to upload a file may vary depending on the + type of REST client. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Name_prefixes' + requestBody: + content: + multipart/form-data: + schema: + required: + - keytab_file + type: object + properties: + keytab_file: + $ref: '#/components/schemas/Keytab_file' + required: true + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/octet-stream: + schema: + $ref: '#/components/schemas/KeytabFileResponse' + text/plain: + schema: + $ref: '#/components/schemas/KeytabFileResponse' + /api/2.23/kmip: + get: + tags: + - KMIP + summary: List KMIP server configurations + description: 'Displays a list of KMIP server configurations. + + ' + parameters: + - $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' + 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/KmipServerResponse' + post: + tags: + - KMIP + summary: Create a KMIP server configuration + description: Creates a KMIP server configuration. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KmipServer' + required: true + x-codegen-request-body-name: kmip-server + 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/KmipServerResponse' + x-codegen-request-body-name: kmip-server + delete: + tags: + - KMIP + summary: Delete a KMIP server configuration + description: 'Deletes a KMIP server configuration. A server can only be deleted + when not in use by the array. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - KMIP + summary: Modify a KMIP server configuration + description: 'Modifies KMIP server properties - URI, certificate, certificate + group. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KmipServer' + required: true + x-codegen-request-body-name: kmip-server + 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/KmipServerResponse' + x-codegen-request-body-name: kmip-server + /api/2.23/kmip/test: + get: + tags: + - KMIP + summary: Displays KMIP server test results + description: 'Displays a detailed result of of KMIP server test. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/json: + schema: + $ref: '#/components/schemas/TestResultResponse' + /api/2.23/legal-holds: + get: + tags: + - Legal Holds + summary: List legal holds + description: List legal holds. + parameters: + - $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' + 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/LegalHoldsGetResponse' + post: + tags: + - Legal Holds + summary: Create a legal hold + description: Create a legal hold instance. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LegalHold' + required: false + x-codegen-request-body-name: hold + 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/LegalHoldsResponse' + x-codegen-request-body-name: hold + delete: + tags: + - Legal Holds + summary: Delete a legal hold + description: Delete a legal hold instance. Deletion is not allowed if the legal + hold is applied to one or more paths. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Legal Holds + summary: Update a legal hold + description: Update a legal hold instance. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LegalHold' + required: false + x-codegen-request-body-name: hold + 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/LegalHoldsResponse' + x-codegen-request-body-name: hold + /api/2.23/legal-holds/held-entities: + get: + tags: + - Legal Holds + summary: List held entities + description: List entities to which a legal hold has been applied. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Paths' + 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/LegalHoldsHeldEntitiesGetResponse' + post: + tags: + - Legal Holds + summary: Apply this legal hold to a new entity + description: 'Apply this legal hold to a new entity. + + The `names`, `file_system_names` and `paths` query parameters are required. + + The `recursive` flag is required when applying a hold to a directory. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Paths' + - $ref: '#/components/parameters/Legal_holds_recursive' + 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/LegalHoldsHeldEntitiesResponse' + patch: + tags: + - Legal Holds + summary: Release this legal hold from the given entity + description: 'Release this legal hold from the given entity. + + The `names`, `file_system_names`, `paths` and `released` query parameters + are required. + + The `recursive` flag is required when releasing a hold from a directory. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Paths' + - $ref: '#/components/parameters/Legal_holds_recursive' + - $ref: '#/components/parameters/Legal_holds_release' + 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/LegalHoldsHeldEntitiesResponse' + /api/2.23/lifecycle-rules: + get: + tags: + - Lifecycle Rules + summary: GET lifecycle-rules + description: 'Returns a list of lifecycle rules. + + If `names` is specified, list the individual rules. + + If `ids` is specified, `bucket_names` or `bucket_ids` is also required. + + If `bucket_names` or `bucket_ids` are specified without `ids`, + + list all the rules for the bucket. + + + ' + 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' + 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. + + ' + 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' + post: + tags: + - Lifecycle Rules + summary: 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 "fbRuleIdX". + + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Confirm_date' + - $ref: '#/components/parameters/Context_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LifecycleRulePost' + 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: 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: 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/LifecycleRulePatch' + 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.23/link-aggregation-groups: + get: + tags: + - Link Aggregation Groups + summary: GET link-aggregation-groups + description: List the status and attributes of the Ethernet ports in the configured + link aggregation groups. + parameters: + - $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' + 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/LinkAggregationGroupGetResponse' + post: + tags: + - Link Aggregation Groups + summary: POST link-aggregation-groups + description: Create a link aggregation group of Ethernet ports on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LinkAggregationGroup' + required: true + x-codegen-request-body-name: link-aggregation-group + 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/LinkAggregationGroupResponse' + x-codegen-request-body-name: link-aggregation-group + delete: + tags: + - Link Aggregation Groups + summary: DELETE link-aggregation-groups + description: Remove a link aggregation group to unbind the ports. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Link Aggregation Groups + summary: PATCH link-aggregation-groups + description: Modify link aggregation groups by adding and removing Ethernet + ports. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LinkAggregationGroupPatch' + required: true + x-codegen-request-body-name: link-aggregation-group + 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/LinkAggregationGroupResponse' + x-codegen-request-body-name: link-aggregation-group + /api/2.23/logs: + get: + tags: + - Logs + summary: GET logs + description: Download a history of log events from the array to provide to Pure + Technical Services for analysis. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/End_time' + - $ref: '#/components/parameters/Start_time' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/octet-stream: + schema: + type: string + format: binary + text/plain: + schema: + type: string + format: binary + application/json: + schema: + type: string + format: binary + /api/2.23/logs-async: + get: + tags: + - Logs + summary: GET logs-async + description: List the attributes and status of preparation for a history of + log events from the array to provide to Pure Technical Services for analysis. + parameters: + - $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' + 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/LogsAsyncGetResponse' + patch: + tags: + - Logs + summary: PATCH logs-async + description: Start the preparation for a history of log events from the array + to provide to Pure Technical Services for analysis. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogsAsync' + required: true + x-codegen-request-body-name: logs-async + 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/LogsAsyncResponse' + x-codegen-request-body-name: logs-async + /api/2.23/logs-async/download: + get: + tags: + - Logs + summary: GET logs-async/download + description: Download the files which contain a history of log events from the + array to provide to Pure Technical Services for analysis. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/octet-stream: + schema: + type: string + format: binary + text/plain: + schema: + type: string + format: binary + application/json: + schema: + type: string + format: binary + /api/2.23/log-targets/file-systems: + get: + tags: + - Audit Log Target for File Systems + summary: GET log-target-file-systems + description: Displays a list of log targets for file systems. + 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' + 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/LogTargetsFileSystemsGetResponse' + post: + tags: + - Audit Log Target for File Systems + summary: POST log-target-file-systems + description: Create a new log target for file systems. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogTargetsFileSystemsPost' + required: false + x-codegen-request-body-name: log-target-file-system + 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/LogTargetsFileSystemsResponse' + x-codegen-request-body-name: log-target-file-system + delete: + tags: + - Audit Log Target for File Systems + summary: DELETE log-target-file-systems + description: Delete one or more log targets. + 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: + - Audit Log Target for File Systems + summary: PATCH log-target-file-systems + description: Modify an existing log target's attributes. + 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/LogTargetsFileSystems' + required: true + x-codegen-request-body-name: log-target-file-system + 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/LogTargetsFileSystemsResponse' + x-codegen-request-body-name: log-target-file-system + /api/2.23/log-targets/object-store: + get: + tags: + - Audit Log Target for Object Store + summary: GET log-targets/object-store + description: Displays a list of log targets for object audit. + 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' + 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/LogTargetsObjectStoreGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/LogTargetsObjectStoreGetResponse' + post: + tags: + - Audit Log Target for Object Store + summary: POST log-targets/object-store + description: Create a new log target for object audit. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LogTargetsObjectStorePost' + required: false + x-codegen-request-body-name: log-target-object-store + 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/LogTargetsObjectStoreResponse' + x-codegen-request-body-name: log-target-object-store + delete: + tags: + - Audit Log Target for Object Store + summary: DELETE log-targets/object-store + description: Delete one or more log targets. + 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: + - Audit Log Target for Object Store + summary: PATCH log-targets/object-store + description: Modify an existing log target's attributes. + 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/LogTargetsObjectStore' + required: true + x-codegen-request-body-name: log-target-object-store + 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/LogTargetsObjectStoreResponse' + x-codegen-request-body-name: log-target-object-store + /api/2.23/maintenance-windows: + get: + tags: + - Maintenance Windows + summary: List maintenance window details + description: Displays maintenance window details, including start time, end + time, and maintenance type. + parameters: + - $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' + 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/MaintenanceWindowsGetResponse' + post: + tags: + - Maintenance Windows + summary: 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 `array`. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/MaintenanceWindowPost' + required: true + x-codegen-request-body-name: maintenance-window + 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/MaintenanceWindowsResponse' + x-codegen-request-body-name: maintenance-window + delete: + tags: + - Maintenance Windows + summary: Delete maintenance window + description: 'Deletes an active maintenance window before its scheduled end + (`expire`) time. + + The `names` parameter is required and must be set to `array`. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/management-access-policies: + get: + tags: + - Policies - Management Access + summary: GET management-access-policies + description: 'Displays a list of management access policies, which can be assigned + to admins, API + + clients, or directory-service roles. + + ' + parameters: + - $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' + 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/ManagementAccessPoliciesGetResponse' + post: + tags: + - Policies - Management Access + summary: POST management-access-policies + description: 'Create a new management access policy, which can be assigned to + admins, API + + clients, or directory-service roles. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManagementAccessPolicyPost' + required: false + x-codegen-request-body-name: policy + 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/ManagementAccessPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Management Access + summary: DELETE management-access-policies + description: Delete one or more management access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Policies - Management Access + summary: PATCH management-access-policies + description: 'Modify an existing management access policy, which can be assigned + to admins, API + + clients, or directory-service roles. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManagementAccessPolicy' + required: true + x-codegen-request-body-name: policy + 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/ManagementAccessPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/management-access-policies/admins: + get: + tags: + - Policies - Management Access + summary: GET management-access-policies/admins + description: 'List management access policies mapped to admins. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - Management Access + summary: POST management-access-policies/admins + description: Map an admin to a management access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - Management Access + summary: DELETE management-access-policies/admins + description: Remove the mapping of an admin to a management access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/management-access-policies/directory-services/roles: + get: + tags: + - Policies - Management Access + summary: GET management-access-policies/directory-services/roles + description: 'List management access policies mapped to directory service group + mappings. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - Management Access + summary: POST management-access-policies/directory-services/roles + description: Map a directory service group to a management access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - Management Access + summary: DELETE management-access-policies/directory-services/roles + description: Remove the mapping of a directory service group to a management + access policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/management-access-policies/members: + get: + tags: + - Policies - Management Access + summary: GET management-access-policies/members + description: 'List the members mapped to management access policies. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + /api/2.23/management-authentication-policies: + get: + tags: + - Policies - Management Authentication + summary: GET management-authentication-policies + description: 'Displays a list of management authentication policies, which can + be assigned to admins and + + arrays. + + ' + 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' + 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/ManagementAuthenticationPoliciesGetResponse' + post: + tags: + - Policies - Management Authentication + summary: POST management-authentication-policies + description: Create management authentication policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ManagementAuthenticationPolicyPost' + required: true + x-codegen-request-body-name: policy + 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/ManagementAuthenticationPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Management Authentication + summary: DELETE management-authentication-policies + description: Delete management authentication policies. + 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: + - Policies - Management Authentication + summary: PATCH management-authentication-policies + description: Modify one or more attributes of management authentication policies. + 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/ManagementAuthenticationPolicy' + required: true + x-codegen-request-body-name: policy + 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/ManagementAuthenticationPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/management-authentication-policies/members: + get: + tags: + - Policies - Management Authentication + summary: GET management-authentication-policies/members + description: List the members mapped to management authentication 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/Management_access_policies_member_types' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Management Authentication + summary: POST management-authentication-policies/members + description: Map a member to a management authentication policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Member_names' + - $ref: '#/components/parameters/Management_access_policies_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/PolicyMemberContextResponse' + delete: + tags: + - Policies - Management Authentication + summary: DELETE management-authentication-policies/members + description: Remove the management authentication policy mapped to a member. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Member_names' + - $ref: '#/components/parameters/Management_access_policies_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.23/network-access-policies: + get: + tags: + - Policies - Network Access + summary: GET network-access-policies + description: Displays a list of network access policies. + parameters: + - $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' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyGetResponse' + patch: + tags: + - Policies - Network Access + summary: PATCH network-access-policies + description: Modify an existing network access policy's attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicy' + required: true + x-codegen-request-body-name: policy + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/network-access-policies/members: + get: + tags: + - Policies - Network Access + summary: GET network-access-policies/members + description: 'List network access policies mapped to different configurations + on the array. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberGetResponse' + /api/2.23/network-access-policies/rules: + get: + tags: + - Policies - Network Access + summary: GET network-access-policies/rules + description: Displays a list of network access policy rules. + parameters: + - $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/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyRuleGetResponse' + post: + tags: + - Policies - Network Access + summary: POST network-access-policies/rules + description: 'Create a new network access policy rule. + + Either `policy_ids` or `policy_names` parameter is required. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyRulePost' + required: true + x-codegen-request-body-name: rule + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - Network Access + summary: DELETE network-access-policies/rules + description: Delete one or more network access policy rules. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + responses: + '200': + description: OK + content: {} + patch: + tags: + - Policies - Network Access + summary: PATCH network-access-policies/rules + description: Modify an existing network access policy rule. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyRule' + required: true + x-codegen-request-body-name: rule + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkAccessPolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/network-interfaces: + get: + tags: + - Network Interfaces + summary: GET network-interfaces + description: List network interfaces and their attributes. + parameters: + - $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' + 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/NetworkInterfaceGetResponse' + post: + tags: + - Network Interfaces + summary: POST network-interfaces + description: Create a VIP to export data or perform replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkInterface' + required: true + x-codegen-request-body-name: network-interface + 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/NetworkInterfaceResponse' + x-codegen-request-body-name: network-interface + delete: + tags: + - Network Interfaces + summary: DELETE network-interfaces + description: Remove a VIP. Once a data VIP is removed, any clients connected + through the data VIP will lose their connection to the file system or bucket. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Network Interfaces + summary: PATCH network-interfaces + description: Modify the attributes of a VIP. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkInterfacePatch' + required: true + x-codegen-request-body-name: network-interface + 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/NetworkInterfaceResponse' + x-codegen-request-body-name: network-interface + /api/2.23/network-interfaces/ping: + get: + tags: + - Network Interfaces + summary: GET network-interfaces/ping + description: 'Display network interface ping result. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ping_trace_component' + - $ref: '#/components/parameters/Ping_count' + - $ref: '#/components/parameters/Ping_trace_destination' + - $ref: '#/components/parameters/Packet_size' + - $ref: '#/components/parameters/Print_latency' + - $ref: '#/components/parameters/Resolve_hostname' + - $ref: '#/components/parameters/Ping_trace_source' + 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/NetworkInterfacePingGetResponse' + /api/2.23/network-interfaces/trace: + get: + tags: + - Network Interfaces + summary: GET network-interfaces/trace + description: 'Display network interface trace result. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ping_trace_component' + - $ref: '#/components/parameters/Ping_trace_destination' + - $ref: '#/components/parameters/Mtu' + - $ref: '#/components/parameters/Fragment_packet' + - $ref: '#/components/parameters/Method' + - $ref: '#/components/parameters/Port' + - $ref: '#/components/parameters/Resolve_hostname' + - $ref: '#/components/parameters/Ping_trace_source' + 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/NetworkInterfaceTraceGetResponse' + /api/2.23/network-interfaces/tls-policies: + get: + tags: + - Policies - TLS + summary: GET network-interfaces/tls-policies + description: List network interface TLS policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - TLS + summary: POST network-interfaces/tls-policies + description: Apply a TLS policy to a specific network interface. A given network + interface may only have 1 TLS policy applied to it at any given time. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - TLS + summary: DELETE network-interfaces/tls-policies + description: Remove a TLS policy from a network interface. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/network-interfaces/connectors: + get: + tags: + - Network Interfaces + summary: GET network-interfaces/connectors + description: List network connector information + parameters: + - $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' + 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/NetworkInterfacesConnectorsGetResponse' + patch: + tags: + - Network Interfaces + summary: PATCH network-interfaces/connectors + description: Modify network connector information. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/HardwareConnector' + required: true + x-codegen-request-body-name: network-connector + 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/NetworkInterfacesConnectorsResponse' + x-codegen-request-body-name: network-connector + /api/2.23/network-interfaces/connectors/performance: + get: + tags: + - Network Interfaces + summary: GET network connectors performance statistics + description: 'Displays network statistics, historical bandwidth, and error reporting + for + + all specified network connectors. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/NetworkInterfacesConnectorsPerformanceGetResponse' + /api/2.23/network-interfaces/connectors/settings: + get: + tags: + - Network Interfaces + summary: GET global network settings for network connectors + description: Display the global network settings for network connectors. + parameters: + - $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' + 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/NetworkInterfacesConnectorsSettingsGetResponse' + /api/2.23/network-interfaces/network-connection-statistics: + get: + tags: + - Network Interfaces + summary: GET network-interfaces/network-connection-statistics + description: 'Display network interface status + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/NetworkConnectionStatisticsCurrent_state' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/NetworkConnectionStatisticsLocal_host' + - $ref: '#/components/parameters/NetworkConnectionStatisticsLocal_port' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/NetworkConnectionStatisticsRemote_host' + - $ref: '#/components/parameters/NetworkConnectionStatisticsRemote_port' + - $ref: '#/components/parameters/Sort' + 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/NetworkConnectionStatisticsGetResponse' + /api/2.23/network-interfaces/neighbors: + get: + tags: + - Network Interfaces + summary: List network interface neighbors + description: Displays all neighbors for all network interfaces on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Local_port_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/NetworkInterfaceNeighborGetResponse' + /api/2.23/nfs-export-policies: + get: + tags: + - Policies - NFS + summary: GET nfs-export-policies + description: Displays a list of NFS export 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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Workload_ids' + - $ref: '#/components/parameters/Workload_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/NfsExportPolicyGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyGetResponse' + post: + tags: + - Policies - NFS + summary: POST nfs-export-policies + description: Create a new NFS export policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyPost' + required: false + x-codegen-request-body-name: policy + 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/NfsExportPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - NFS + summary: DELETE nfs-export-policies + description: Delete one or more NFS export policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Policies - NFS + summary: PATCH nfs-export-policies + description: Modify an existing NFS export policy's attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyPatch' + required: true + x-codegen-request-body-name: policy + 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/NfsExportPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/nfs-export-policies/rules: + get: + tags: + - Policies - NFS + summary: GET nfs-export-policies/rules + description: 'Displays a list of NFS export policy rules. + + The default sort is by policy name, then index. + + ' + 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/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/NfsExportPolicyRuleGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyRuleGetResponse' + post: + tags: + - Policies - NFS + summary: POST nfs-export-policies/rules + description: 'Add a NFS export policy rule. Rules are ordered in three groups; + ip addresses, other and `*`. + + The new rule will be added at the end of the appropriate group if neither + + `before_rule_id` and `before_rule_name` are specified. Rules can only be inserted + into the + + appropriate group. + + Either `policy_ids` or `policy_names` parameter is required. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyRule' + 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/NfsExportPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - NFS + summary: DELETE nfs-export-policies/rules + description: 'Delete one or more NFS export policy rules. + + One of the following is required: `ids` or `names`. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Policies - NFS + summary: PATCH nfs-export-policies/rules + description: 'Modify an existing NFS export policy rule. + + If `before_rule_id` or `before_rule_name` are specified, the rule will be + moved before that + + rule. Rules are ordered in three groups; ip addresses, other and `*` and can + only be moved + + within the appropriate group. + + One of the following is required: `ids` or `names`. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NfsExportPolicyRulePatch' + 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/NfsExportPolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/nodes: + get: + tags: + - Nodes + summary: GET nodes + description: List one or more nodes. + parameters: + - $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_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/NodeGetResponse' + patch: + tags: + - Nodes + summary: PATCH nodes + description: Modify a node's attributes including its management address and + serial number. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Node' + required: false + x-codegen-request-body-name: node + 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/NodeResponse' + x-codegen-request-body-name: node + /api/2.23/nodes/batch: + post: + tags: + - Nodes + summary: POST nodes/batch + description: Add one or more nodes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Add_to_groups' + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Node' + required: true + x-codegen-request-body-name: items + 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/NodeResponse' + x-codegen-request-body-name: items + /api/2.23/node-groups: + get: + tags: + - Node Groups + summary: GET node-groups + description: Display all array node groups. + parameters: + - $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' + 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/NodeGroupGetResponse' + post: + tags: + - Node Groups + summary: POST node-groups + description: Create one or more node groups on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupResponse' + patch: + tags: + - Node Groups + summary: PATCH node-groups + description: Update one or more node groups on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/NodeGroupPatch' + required: true + x-codegen-request-body-name: node-group + 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/NodeGroupResponse' + delete: + tags: + - Node Groups + summary: DELETE node-groups + description: Delete one or more node groups from the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/node-groups/nodes: + get: + tags: + - Node Groups + summary: GET node-groups/nodes + description: List membership associations between node groups and nodes on the + array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Node_group_ids' + - $ref: '#/components/parameters/Node_group_names' + - $ref: '#/components/parameters/Node_ids' + - $ref: '#/components/parameters/Node_names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/NodeGroupNodeGetResponse' + post: + tags: + - Node Groups + summary: POST node-groups/nodes + description: Add one or more nodes to one or more node groups on the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Node_group_ids' + - $ref: '#/components/parameters/Node_group_names' + - $ref: '#/components/parameters/Node_ids' + - $ref: '#/components/parameters/Node_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/NodeGroupNodeResponse' + delete: + tags: + - Node Groups + summary: DELETE node-groups/nodes + description: Remove one or more nodes from one or more groups. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Node_group_ids' + - $ref: '#/components/parameters/Node_group_names' + - $ref: '#/components/parameters/Node_ids' + - $ref: '#/components/parameters/Node_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.23/node-groups/uses: + get: + tags: + - Node Groups + summary: GET node-groups/uses + description: List how node groups are being used and by what. + parameters: + - $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' + 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/NodeGroupUseGetResponse' + /api/2.23/object-store-access-keys: + get: + tags: + - Object Store Access Keys + summary: 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' + 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. + + ' + 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' + post: + tags: + - Object Store Access Keys + summary: POST object-store-access-keys + description: 'Create or import object store access keys. When importing an access + key, + + the access key id is provided by the `names` header parameter and the + + the secret key must be also provided. When importing an access key for a + + user in a realm, the value of `names` must be prefixed with the realm of the + + user. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Access_key_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccessKeyPost' + 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: 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: 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.23/object-store-access-policies: + get: + tags: + - Policies - Object Store Access + summary: GET object-store-access-policies + description: List access policies 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/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' + 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. + + ' + 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' + post: + tags: + - Policies - Object Store Access + summary: POST object-store-access-policies + description: Create a new access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Enforce_action_restrictions' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccessPolicyPost' + required: false + x-codegen-request-body-name: policy + 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/ObjectStoreAccessPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Object Store Access + summary: DELETE object-store-access-policies + description: Delete one or more access policies. + 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: + - Policies - Object Store Access + summary: PATCH object-store-access-policies + description: Modify the rules of an object store access policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Enforce_action_restrictions' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccessPolicyPatch' + required: false + x-codegen-request-body-name: policy + 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/ObjectStoreAccessPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/object-store-access-policies/object-store-roles: + get: + tags: + - Policies - Object Store Access + summary: GET object-store-access-policies/object-store-roles + description: List object store roles 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' + 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/PolicyMemberContextGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Object Store Access + summary: POST object-store-access-policies/object-store-roles + description: Grant access policies to an object store role. + 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/PolicyMemberContextResponse' + delete: + tags: + - Policies - Object Store Access + summary: DELETE object-store-access-policies/object-store-roles + description: Revoke an object store role'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.23/object-store-access-policies/object-store-users: + get: + tags: + - Policies - Object Store Access + summary: GET object-store-access-policies/object-store-users + 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' + 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/PolicyMemberContextGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Object Store Access + summary: POST object-store-access-policies/object-store-users + 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/PolicyMemberContextResponse' + delete: + tags: + - Policies - Object Store Access + summary: DELETE object-store-access-policies/object-store-users + 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/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.23/object-store-access-policies/rules: + get: + tags: + - Policies - Object Store Access + summary: GET object-store-access-policies-rules + description: List access policy rules 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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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. + + ' + 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' + post: + tags: + - Policies - Object Store Access + summary: POST object-store-access-policies-rules + description: Create a new access policy rule. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Enforce_action_restrictions' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyRuleObjectAccessPost' + 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/ObjectStoreAccessPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - Object Store Access + summary: DELETE object-store-access-policies-rules + description: Delete one or more access policy rules. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Policies - Object Store Access + summary: PATCH object-store-access-policies-rules + description: Modify an access policy rule's attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Enforce_action_restrictions' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyRuleObjectAccessPost' + 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/ObjectStoreAccessPolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/object-store-access-policy-actions: + get: + tags: + - Policies - Object Store Access + summary: GET object-store-access-policy-actions + description: 'List valid actions for access policy rules. Each action is either + a valid + + AWS S3 action (prefixed by `s3:`) or our special wildcard action (`s3:*`). + + Each action, when included in a rule, may restrict which other properties + + may be set for that rule. + + + ' + 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' + 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/ObjectStoreAccessPolicyActionGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccessPolicyActionGetResponse' + /api/2.23/object-store-accounts: + get: + tags: + - Object Store Accounts + summary: GET object-store-accounts + description: List object store accounts 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_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. + + ' + 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' + post: + tags: + - Object Store Accounts + summary: POST object-store-accounts + description: 'Create an object store account. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccountPost' + required: false + x-codegen-request-body-name: object-store-account + 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: DELETE object-store-accounts + description: Delete 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: {} + patch: + tags: + - Object Store Accounts + summary: PATCH object-store-accounts + description: Modify object store account attributes such as quota limit and + bucket defaults. + parameters: + - $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/ObjectStoreAccountPatch' + required: true + x-codegen-request-body-name: object-store-account + 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 + /api/2.23/object-store-account-exports: + get: + tags: + - Object Store Account Exports + summary: GET object-store-account-exports + description: List one or more object store account exports. + 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' + 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/ObjectStoreAccountExportGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccountExportGetResponse' + post: + tags: + - Object Store Account Exports + summary: POST object-store-account-exports + description: Create an account export. + 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' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreAccountExportPost' + required: true + x-codegen-request-body-name: object-store-account-export + 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/ObjectStoreAccountExportResponse' + x-codegen-request-body-name: object-store-account-export + delete: + tags: + - Object Store Account Exports + summary: DELETE object-store-account-exports + description: Deletes an account export. + 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: + - Object Store Account Exports + summary: PATCH object-store-account-exports + description: "Modify an account export\u2019s attributes." + 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/ObjectStoreAccountExportPatch' + required: true + x-codegen-request-body-name: object-store-account-export + 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/ObjectStoreAccountExportResponse' + x-codegen-request-body-name: object-store-account-export + /api/2.23/object-store-remote-credentials: + get: + tags: + - Object Store Remote Credentials + summary: GET object-store-remote-credentials + description: List object store remote credentials used by bucket replica links + to access buckets on remote arrays or targets. + 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' + 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/ObjectStoreRemoteCredentialGetResp' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRemoteCredentialGetResp' + post: + tags: + - Object Store Remote Credentials + summary: POST object-store-remote-credentials + description: Create object store remote credentials to set up bucket replicat + links to a remote array or target. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRemoteCredentialsPost' + required: true + x-codegen-request-body-name: remote-credentials + 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/ObjectStoreRemoteCredentialsResp' + x-codegen-request-body-name: remote-credentials + delete: + tags: + - Object Store Remote Credentials + summary: DELETE object-store-remote-credentials + description: Delete object store remote credentials. + 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: + - Object Store Remote Credentials + summary: PATCH object-store-remote-credentials + description: Rename and/or change the access key/secret key pair for object + store remote credentials. + 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/ObjectStoreRemoteCredentials' + required: true + x-codegen-request-body-name: remote-credentials + 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/ObjectStoreRemoteCredentialsResp' + x-codegen-request-body-name: remote-credentials + /api/2.23/object-store-roles: + get: + tags: + - Object Store Roles + summary: GET object-store-roles + description: List object store roles 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' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRoleGetResponse' + '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/ObjectStoreRoleGetResponse' + post: + tags: + - Object Store Roles + summary: POST object-store-roles + description: Create new object store roles. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRolePost' + required: true + x-codegen-request-body-name: object-store-role + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRoleResponse' + x-codegen-request-body-name: object-store-role + delete: + tags: + - Object Store Roles + summary: DELETE object-store-roles + description: Delete existing object store roles. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + responses: + '200': + description: OK + content: {} + patch: + tags: + - Object Store Roles + summary: PATCH object-store-roles + description: Modify existing object store roles. + 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/ObjectStoreRole' + required: true + x-codegen-request-body-name: object-store-role + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreRoleResponse' + x-codegen-request-body-name: object-store-role + /api/2.23/object-store-roles/object-store-access-policies: + get: + tags: + - Object Store Roles + summary: GET object-store-roles/object-store-access-policies + description: List object store roles 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' + 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/PolicyMemberContextGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Object Store Roles + summary: POST object-store-roles/object-store-access-policies + description: Grant access policies to an object store role. + 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/PolicyMemberContextResponse' + delete: + tags: + - Object Store Roles + summary: DELETE object-store-roles/object-store-access-policies + description: Revoke an object store role'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.23/object-store-roles/object-store-trust-policies: + get: + tags: + - Object Store Roles + summary: GET object-store-roles/object-store-trust-policies + description: List object store roles and their trust 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/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + - $ref: '#/components/parameters/Sort' + 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/ObjectStoreTrustPolicyGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreTrustPolicyGetResponse' + /api/2.23/object-store-roles/object-store-trust-policies/download: + get: + tags: + - Object Store Roles + summary: GET object-store-roles/object-store-trust-policies/download + description: Download object store roles and their trust policies in native + AWS format. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_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/ObjectStoreTrustPolicyIam' + /api/2.23/object-store-roles/object-store-trust-policies/upload: + patch: + tags: + - Object Store Roles + summary: PATCH object-store-roles/object-store-trust-policies/upload + description: Upload object store roles and their trust policies in native AWS + format. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + requestBody: + description: The trust policy document to upload. + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreTrustPolicyIam' + required: true + x-codegen-request-body-name: policy_document + 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/ObjectStoreTrustPolicyResponse' + x-codegen-request-body-name: policy_document + /api/2.23/object-store-roles/object-store-trust-policies/rules: + get: + tags: + - Object Store Roles + summary: GET object-store-roles/object-store-trust-policies/rules + description: List trust policy rules 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/Indices' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + - $ref: '#/components/parameters/Sort' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreTrustPolicyRuleGetResponse' + '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/ObjectStoreTrustPolicyRuleGetResponse' + post: + tags: + - Object Store Roles + summary: POST object-store-roles/object-store-trust-policies/rules + description: Create a new trust policy rule. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrustPolicyRulePost' + required: true + x-codegen-request-body-name: rule + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreTrustPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Object Store Roles + summary: DELETE object-store-roles/object-store-trust-policies/rules + description: Delete one or more trust policy rules. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Indices' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + responses: + '200': + description: OK + content: {} + patch: + tags: + - Object Store Roles + summary: PATCH object-store-roles/object-store-trust-policies/rules + description: Modify a trust policy rule's attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Indices' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Object_store_role_ids' + - $ref: '#/components/parameters/Object_store_role_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TrustPolicyRulePost' + required: true + x-codegen-request-body-name: rule + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreTrustPolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/object-store-users: + get: + tags: + - Object Store Users + summary: 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' + 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. + + ' + 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' + post: + tags: + - Object Store Users + summary: 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/Full_access' + - $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: 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.23/object-store-users/object-store-access-policies: + get: + tags: + - Object Store Users + summary: GET object-store-users/object-store-access-policies + 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' + 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/PolicyMemberContextGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Object Store Users + summary: POST object-store-users/object-store-access-policies + 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/PolicyMemberContextResponse' + delete: + tags: + - Object Store Users + summary: DELETE object-store-users/object-store-access-policies + description: "Revoke an object store user\u2019s 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.23/object-store-virtual-hosts: + get: + tags: + - Object Store Virtual Hosts + summary: GET object-store-virtual-hosts + description: List 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' + 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: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreVirtualHostGetResponse' + post: + tags: + - Object Store Virtual Hosts + summary: POST object-store-virtual-hosts + description: 'Create an object store virtual host. + + + Only 10 virtual hosts are supported. + + + A `hostname` cannot exceed 255 characters in length, it cannot be an IP address, + + supersets or subsets of existing hostnames with the same root are not allowed. + + The default `hostname` is s3.amazonaws.com and it cannot be deleted. + + + Either `name` or `id` must be provided for each attached server. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreVirtualHost' + x-codegen-request-body-name: object-store-virtual-host + 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: DELETE object-store-virtual-hosts + description: Delete 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: {} + patch: + tags: + - Object Store Virtual Hosts + summary: PATCH object-store-virtual-hosts + description: 'Modify an existing object store virtual host. + + + A `hostname` cannot exceed 255 characters in length, it cannot be an IP address, + + supersets or subsets of existing hostnames with the same root are not allowed. + + + Either `name` or `id` must be provided for each attached server. If `attached_servers` + + is specified, the whole list of attached servers will be replaced. The servers + + listed in `add_attached_servers` will be added to the existing list of attached + + servers and the servers listed in `remove_attached_servers` will be removed + from + + the existing list of attached servers. If both `add_attached_servers` and + + `remove_attached_servers` are specified, the two sets of servers must + + be disjoint. If `add_attached_servers` or `remove_attached_servers` are specified, + + `attached_servers` must not be specified. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectStoreVirtualHostPatch' + x-codegen-request-body-name: object-store-virtual-host + 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' + /api/2.23/password-policies: + get: + tags: + - Policies - Password + summary: List password policies + description: 'Displays a list of password policies. + + ' + parameters: + - $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' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordPoliciesGetResponse' + patch: + tags: + - Policies - Password + summary: 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/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordPolicy' + required: true + x-codegen-request-body-name: policy + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PasswordPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/policies: + get: + tags: + - Policies - Snapshot + summary: GET policies + description: Display snapshot scheduling policies 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/Workload_ids' + - $ref: '#/components/parameters/Workload_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/PolicyGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyGetResponse' + post: + tags: + - Policies - Snapshot + summary: POST policies + description: Create a new snapshot scheduling policy with rule attributes to + capture file system snapshots for a set period of time and frequency, as well + as how long snapshots are retained before being destroyed and eradicated. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyPost' + required: false + x-codegen-request-body-name: policy + 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/PolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Snapshot + summary: DELETE policies + description: Delete one or more snapshot scheduling policies. + 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: + - Policies - Snapshot + summary: PATCH policies + description: Modify a snapshot scheduling policy's attributes for when and how + often snapshots are created and how long they are retained. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Destroy_snapshots' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnapshotPolicyPatch' + required: true + x-codegen-request-body-name: policy + 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/PolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/policies/file-systems: + get: + tags: + - Policies - Snapshot + summary: GET policies/file-systems + description: 'List file systems mapped to a snapshot scheduling policy. + + Note: if more than 150,000 items would be returned in the response, an error + will be thrown + + and query parameters must be used to limit the items queried. + + ' + 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' + 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/PolicyMemberContextGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Policies - Snapshot + summary: POST policies/file-systems + description: Map a file system to a snapshot scheduling 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: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextResponse' + delete: + tags: + - Policies - Snapshot + summary: DELETE policies/file-systems + description: Remove the snapshot scheduling policy mapped to a file system. + 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.23/policies/file-system-snapshots: + get: + tags: + - Policies - Snapshot + summary: GET policies/file-system-snapshots + description: 'List file system snapshots mapped to a snapshot scheduling policy. + + Note: if more than 150,000 items would be returned in the response, an error + will be thrown + + and query parameters must be used to limit the items queried. + + ' + 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' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyFileSystemSnapshotGetResponse' + '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/PolicyFileSystemSnapshotGetResponse' + delete: + tags: + - Policies - Snapshot + summary: DELETE policies/file-system-snapshots + description: Remove the snapshot scheduling policy mapped to a file system. + 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 + content: {} + /api/2.23/policies/members: + get: + tags: + - Policies - Snapshot + summary: GET policies/members + description: 'List snapshot scheduling policies mapped to file systems, snapshots, + and file system replica links. + + Note: if more than 150,000 items would be returned in the response, an error + will be thrown + + and query parameters must be used to limit the items queried. + + ' + 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/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $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/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + 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/PolicyMemberWithRemoteGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberWithRemoteGetResponse' + /api/2.23/policies/file-system-replica-links: + get: + tags: + - Policies - Snapshot + summary: GET policies/file-system-replica-links + description: 'List snapshot scheduling policies for file system replica links. + + Note: if more than 150,000 items would be returned in the response, an error + will be thrown + + and query parameters must be used to limit the items queried. + + ' + 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/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberWithRemoteGetResponse' + '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/PolicyMemberWithRemoteGetResponse' + post: + tags: + - Policies - Snapshot + summary: POST policies/file-system-replica-links + description: Add a snapshot scheduling policy to a file system replica link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberWithRemoteResponse' + delete: + tags: + - Policies - Snapshot + summary: DELETE policies/file-system-replica-links + description: Remove a snapshot scheduling policy mapped to a file system replica + link. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $ref: '#/components/parameters/Member_ids' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + responses: + '200': + description: OK + content: {} + /api/2.23/policies-all: + get: + tags: + - Policies (All) + summary: GET policies-all + description: List all policies of all types. + 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' + 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/PolicyBaseGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyBaseGetResponse' + /api/2.23/policies-all/members: + get: + tags: + - Policies (All) + summary: GET policies-all/members + description: 'List policies (of all types) mapped to other entities (file systems, + + snapshots, file system replica links, and object store users). + + Note: if more than 150,000 items would be returned in the response, an error + will be thrown + + and query parameters must be used to limit the items queried. + + ' + 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/Local_file_system_ids' + - $ref: '#/components/parameters/Local_file_system_names' + - $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/Remote_file_system_ids' + - $ref: '#/components/parameters/Remote_file_system_names' + - $ref: '#/components/parameters/Remote_ids' + - $ref: '#/components/parameters/Remote_names' + - $ref: '#/components/parameters/Sort' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberWithRemoteGetResponse' + '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/PolicyMemberWithRemoteGetResponse' + /api/2.23/public-keys: + get: + tags: + - Public Keys + summary: List public key configurations + description: List public key configurations. + parameters: + - $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' + 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/PublicKeyGetResponse' + post: + tags: + - Public Keys + summary: Create public key configurations + description: Creates public key configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PublicKeyPost' + required: true + x-codegen-request-body-name: public_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/PublicKeyResponse' + x-codegen-request-body-name: public_key + delete: + tags: + - Public Keys + summary: Delete public key configurations + description: Deletes public key configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/public-keys/uses: + get: + tags: + - Public Keys + summary: GET public-keys/uses + description: List how public keys are being used and by what. + parameters: + - $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' + 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/PublicKeyUseGetResponse' + /api/2.23/qos-policies: + get: + tags: + - Policies - QoS + summary: GET qos-policies + description: List QoS 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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/QosPoliciesGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/QosPoliciesGetResponse' + post: + tags: + - Policies - QoS + summary: POST qos-policies + description: Create a QoS policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QosPolicy' + required: true + x-codegen-request-body-name: policy + 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/QosPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - QoS + summary: DELETE qos-policies + description: Delete a QoS policy. + 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: + - Policies - QoS + summary: PATCH qos-policies + description: Modify a QoS policy. + 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/QosPolicy' + required: false + x-codegen-request-body-name: policy + 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/QosPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/qos-policies/file-systems: + get: + tags: + - Policies - QoS + summary: GET qos-policies/file-systems + description: List qos policies and their file system members. + 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' + 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/PolicyMemberContextGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + /api/2.23/qos-policies/members: + get: + tags: + - Policies - QoS + summary: GET qos-policies/members + description: List qos policies and their managed object members. + 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_qos' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/PolicyMemberContextGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + post: + tags: + - Policies - QoS + summary: POST qos-policies/members + description: Map a managed object to a qos 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_qos_no_buckets' + - $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/PolicyMemberContextResponse' + delete: + tags: + - Policies - QoS + summary: DELETE qos-policies/members + description: Remove the qos policy mapped to a managed object. + 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_qos_no_buckets' + - $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.23/qos-policies/buckets: + get: + tags: + - Policies - QoS + summary: GET qos-policies/buckets + description: List qos policies and their bucket members. + 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' + 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/PolicyMemberContextGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyMemberContextGetResponse' + /api/2.23/quotas/groups: + get: + tags: + - Quotas + summary: GET quotas/groups + description: List groups with hard limit quotas. + parameters: + - $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/Gids' + - $ref: '#/components/parameters/Group_names' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/GroupQuotaGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/GroupQuotaGetResponse' + post: + tags: + - Quotas + summary: POST quotas/groups + description: Create a hard limit quota for a group. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Gids' + - $ref: '#/components/parameters/Group_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GroupQuotaPost' + required: false + x-codegen-request-body-name: quota + 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/GroupQuotaResponse' + x-codegen-request-body-name: quota + delete: + tags: + - Quotas + summary: DELETE quotas/groups + description: Delete a hard limit quota for a group. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Gids' + - $ref: '#/components/parameters/Group_names' + - $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: + - Quotas + summary: PATCH quotas/groups + description: Modify a quota for a group. Note that if you modify a group's quota + to a lower value and that group's usage has already exceeded the new value, + writes will automatically halt until usage decreases below the new quota setting. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Gids' + - $ref: '#/components/parameters/Group_names' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GroupQuotaPatch' + required: false + x-codegen-request-body-name: quota + 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/GroupQuotaResponse' + x-codegen-request-body-name: quota + /api/2.23/quotas/settings: + get: + tags: + - Quotas + summary: GET quotas-settings + description: List notification attributes of a group or user quota. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/json: + schema: + $ref: '#/components/schemas/QuotaSettingGetResponse' + patch: + tags: + - Quotas + summary: PATCH quotas-settings + description: Modify the notification attributes of a group or user quota. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QuotaSetting' + required: true + x-codegen-request-body-name: quota-setting + 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/QuotaSettingResponse' + x-codegen-request-body-name: quota-setting + /api/2.23/quotas/users: + get: + tags: + - Quotas + summary: GET quotas/users + description: List users with hard limit file system quotas. + parameters: + - $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/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Uids' + - $ref: '#/components/parameters/User_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/UserQuotaGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UserQuotaGetResponse' + post: + tags: + - Quotas + summary: POST quotas/users + description: Create a hard limit file system quota for a user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Uids' + - $ref: '#/components/parameters/User_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserQuotaPost' + required: false + x-codegen-request-body-name: quota + 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/UserQuotaResponse' + x-codegen-request-body-name: quota + delete: + tags: + - Quotas + summary: DELETE quotas/users + description: Delete a hard limit file system quota for a user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Uids' + - $ref: '#/components/parameters/User_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: + - Quotas + summary: PATCH quotas/users + description: "Modify the attributes of a hard limit file system quota. Note + that if you modify a user's quota to a lower value and that user\u2019s usage + has already exceeded the new value, writes will automatically halt until usage + decreases below the new quota setting." + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Uids' + - $ref: '#/components/parameters/User_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UserQuotaPatch' + required: false + x-codegen-request-body-name: quota + 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/UserQuotaResponse' + x-codegen-request-body-name: quota + /api/2.23/presets/workload: + get: + tags: + - Presets + summary: List workload presets + description: 'Displays a list of workload presets. + + ' + parameters: + - $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: 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/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: Create a workload preset + description: 'Creates one workload preset. + + ' + parameters: + - $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: 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/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: 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/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.23/rapid-data-locking: + get: + tags: + - RDL + summary: Get the status of the Rapid Data Locking feature. + description: 'Displays the status of the Rapid Data Locking feature. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RapidDataLockingResponse' + patch: + tags: + - RDL + summary: Modifies the Rapid Data Locking feature. + description: 'Modifies the Rapid Data Locking feature. Note that the feature + can only + + be enabled if there are no file systems nor buckets created on the array. + + Once enabled, the feature cannot be modified. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RapidDataLocking' + required: true + x-codegen-request-body-name: rapid-data-locking + 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/RapidDataLockingResponse' + x-codegen-request-body-name: rapid-data-locking + /api/2.23/rapid-data-locking/test: + get: + tags: + - RDL + summary: Displays Rapid Data Locking test results. + description: 'Displays a detailed result of a Rapid Data Locking test. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TestResultResponse' + /api/2.23/rapid-data-locking/rotate: + post: + tags: + - RDL + summary: Rotates the external keys on the associated EKM appliance. + description: 'Rotates the external keys on the associated EKM appliance. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/realms: + get: + tags: + - Realms + summary: GET realms + description: Displays a list of realms. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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_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/RealmGetResponse' + post: + tags: + - Realms + summary: POST realms + description: Create a new realm. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Without_default_access_list' + 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/RealmResponse' + delete: + tags: + - Realms + summary: DELETE Realms + description: 'Deletes a realm that has been destroyed and is pending eradication. + + Eradicated realms cannot be recovered. Realms are destroyed using the PATCH + method. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Realms + summary: PATCH realms + description: Modify an existing realm's attributes, including destroying a realm. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $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.23/realms/defaults: + get: + tags: + - Realms + summary: GET realms/defaults + description: 'List of default configurations for realms. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Realm_ids' + - $ref: '#/components/parameters/Realm_names' + - $ref: '#/components/parameters/Sort' + 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/RealmDefaultsGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RealmDefaultsGetResponse' + patch: + tags: + - Realms + summary: PATCH realms/defaults + description: 'Modify a default configuration for a realm. + + ' + parameters: + - $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/RealmDefaults' + required: true + x-codegen-request-body-name: default_realm_configuration + 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/RealmDefaultsResponse' + x-codegen-request-body-name: default_realm_configuration + /api/2.23/realms/space: + get: + tags: + - Realms + summary: GET realms/space + description: List used storage space for the realm. + parameters: + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/Total_only' + - $ref: '#/components/parameters/Type' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/RealmSpaceGetResponse' + /api/2.23/realms/space/storage-classes: + get: + tags: + - Realms + summary: GET realms/space/storage-classes + description: List used storage space for storage classes in the realm. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $ref: '#/components/parameters/StorageClassNames' + - $ref: '#/components/parameters/Total_only' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RealmSpaceStorageClassGetResponse' + /api/2.23/remote-arrays: + get: + tags: + - Remote Arrays + summary: List remote arrays + description: 'Lists arrays in the current fleet, as well as arrays that the + current array has existing + + replication connections to. + + + ' + parameters: + - $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_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/RemoteArraysResponse' + /api/2.23/resiliency-groups: + get: + tags: + - Resiliency Groups + summary: GET resiliency-groups + description: Display all array resiliency groups. + parameters: + - $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' + 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/ResiliencyGroupGetResponse' + /api/2.23/resiliency-groups/members: + get: + tags: + - Resiliency Groups + summary: GET resiliency-groups/members + description: List membership associations between resiliency groups and nodes + added to the array. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/Resiliency_group_ids' + - $ref: '#/components/parameters/Resiliency_group_names' + - $ref: '#/components/parameters/Sort' + 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/ResiliencyGroupMemberGetResponse' + /api/2.23/resource-accesses: + get: + tags: + - Resource Accesses + summary: GET resource-accesses + description: 'Returns a list of configured resource accesses. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit_scale' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/ResourceAccessesGetResponse' + delete: + tags: + - Resource Accesses + summary: DELETE resource-accesses + description: 'Delete resource access object. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + /api/2.23/resource-accesses/batch: + post: + tags: + - Resource Accesses + summary: POST resource-accesses/batch + description: 'Create resource access objects. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ResourceAccessPost' + required: true + x-codegen-request-body-name: items + 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/ResourceAccessesResponse' + x-codegen-request-body-name: items + /api/2.23/roles: + get: + tags: + - Roles + summary: GET roles + description: List roles and permission attributes for role-based access control + (RBAC). + parameters: + - $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' + 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/RoleGetResponse' + /api/2.23/s3-export-policies: + get: + tags: + - Policies - S3 Export + summary: GET s3-export-policies + description: 'List S3 export 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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/S3ExportPolicyGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/S3ExportPolicyGetResponse' + post: + tags: + - Policies - S3 Export + summary: POST s3-export-policies + description: 'Create a new S3 export policy. + + + A non-empty list must be supplied in `servers`. The export is enabled + + after creation by default, this can be changed by setting `export_enabled` + + to `false`. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/S3ExportPolicyPost' + required: true + x-codegen-request-body-name: policy + 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/S3ExportPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - S3 Export + summary: DELETE s3-export-policies + description: 'Delete an S3 export policy. + + ' + 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: + - Policies - S3 Export + summary: PATCH s3-export-policies + description: 'Modify an existing S3 export policy. + + ' + 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/S3ExportPolicyPatch' + required: true + x-codegen-request-body-name: policy + 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/S3ExportPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/s3-export-policies/rules: + get: + tags: + - Policies - S3 Export + summary: GET s3-export-policies/rules + description: 'List rules for the specified S3 export policy. Currently, either + + `policy_names` or `policy_ids` query parameters must be used and + + contain exactly one element. + + ' + 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' + 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/S3ExportPolicyRuleGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/S3ExportPolicyRuleGetResponse' + post: + tags: + - Policies - S3 Export + summary: POST s3-export-policies/rules + description: 'Create a new rule for the specified S3 export policy. Either `policy_names` + + or `policy_ids` query parameters can be used. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/S3ExportPolicyRulePost' + 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/S3ExportPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - S3 Export + summary: DELETE s3-export-policies/rules + description: 'Delete rules for the specified S3 export policy. Either `policy_names` + + or `policy_ids` query parameters can be used. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + - $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: {} + patch: + tags: + - Policies - S3 Export + summary: PATCH s3-export-policies/rules + description: 'Modify rules of S3 export policies. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/S3ExportPolicyRulePost' + 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/S3ExportPolicyRuleResponse' + /api/2.23/sso/oidc/idps: + get: + tags: + - OIDC SSO + summary: List OIDC SSO configurations + description: Displays the OIDC SSO configuration settings in the array. + parameters: + - $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' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OidcSsoGetResponse' + post: + tags: + - OIDC SSO + summary: Create OIDC SSO configuration + description: Create OIDC SSO configuration. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OidcSsoPost' + required: true + x-codegen-request-body-name: idp + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OidcSsoResponse' + x-codegen-request-body-name: idp + delete: + tags: + - OIDC SSO + summary: Delete OIDC SSO configurations + description: Delete OIDC SSO configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + responses: + '200': + description: OK + content: {} + patch: + tags: + - OIDC SSO + summary: Modify OIDC SSO configuration + description: Modify one or more attributes of OIDC SSO configuration. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OidcSsoPatch' + required: true + x-codegen-request-body-name: idp + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OidcSsoResponse' + x-codegen-request-body-name: idp + /api/2.23/sso/saml2/idps: + get: + tags: + - SAML2 SSO + summary: List SAML2 SSO configurations + description: 'Displays the SAML2 SSO service provider and identity provider + configuration + + settings in the array. + + ' + parameters: + - $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' + 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/Saml2SsoGetResponse' + post: + tags: + - SAML2 SSO + summary: Create SAML2 SSO configurations + description: Creates SAML2 SSO configurations. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/Saml2SsoResponse' + x-codegen-request-body-name: idp + delete: + tags: + - SAML2 SSO + summary: Delete SAML2 SSO configurations + description: Deletes SAML2 SSO configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - SAML2 SSO + summary: Modify SAML2 SSO configurations + description: Modifies one or more attributes of SAML2 SSO configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Saml2Sso' + required: true + x-codegen-request-body-name: idp + 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/Saml2SsoResponse' + x-codegen-request-body-name: idp + /api/2.23/sso/saml2/idps/test: + get: + tags: + - SAML2 SSO + summary: GET sso/saml2/idps/test + description: 'Test the existing SAML2 SSO configurations in the array. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Sort' + 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/TestResultResponse' + patch: + tags: + - SAML2 SSO + summary: PATCH sso/saml2/idps/test + description: 'Modifies and test 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/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Saml2Sso' + required: true + x-codegen-request-body-name: idp + 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/TestResultResponse' + x-codegen-request-body-name: idp + /api/2.23/storage-class-tiering-policies: + get: + tags: + - Policies - Storage Class Tiering + summary: GET storage-class-tiering-policies + description: List storage class tiering policies. + parameters: + - $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' + 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/StorageClassTieringPoliciesGetResponse' + post: + tags: + - Policies - Storage Class Tiering + summary: POST storage-class-tiering-policies + description: Create a storage class tiering policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StorageClassTieringPolicy' + required: false + x-codegen-request-body-name: policy + 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/StorageClassTieringPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - Storage Class Tiering + summary: DELETE storage-class-tiering-policies + description: 'Delete a storage class tiering policy. + + Deletion is not allowed if the policy is attached to one or more file systems. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Policies - Storage Class Tiering + summary: PATCH storage-class-tiering-policies + description: Modify a storage class tiering policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StorageClassTieringPolicy' + required: false + x-codegen-request-body-name: policy + 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/StorageClassTieringPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/storage-class-tiering-policies/members: + get: + tags: + - Policies - Storage Class Tiering + summary: GET storage-class-tiering-policies/members + description: List members mapped to a storage class tiering policy. + 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' + 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/StorageClassTieringPoliciesMembersGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/StorageClassTieringPoliciesMembersGetResponse' + /api/2.23/servers: + get: + tags: + - Servers + summary: GET servers + description: List servers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/ServerGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/ServerGetResponse' + post: + tags: + - Servers + summary: POST servers + description: Add a server. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Create_ds' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServerPost' + required: true + x-codegen-request-body-name: server + 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/ServerResponse' + x-codegen-request-body-name: server + delete: + tags: + - Servers + summary: DELETE servers + description: Delete a server. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Cascade_delete' + - $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: + - Servers + summary: PATCH servers + description: Modify the server attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ServerPost' + required: true + x-codegen-request-body-name: server + 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/ServerResponse' + x-codegen-request-body-name: server + /api/2.23/sessions: + get: + tags: + - Sessions + summary: List session data + description: Displays session data for user login events performed in the Purity//FB + GUI, CLI, and REST API. + parameters: + - $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' + 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/SessionGetResponse' + /api/2.23/smb-client-policies: + get: + tags: + - Policies - SMB Client + summary: GET smb-client-policies + description: Display SMB Client policies 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/Workload_ids' + - $ref: '#/components/parameters/Workload_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/SmbClientPolicyGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SmbClientPolicyGetResponse' + post: + tags: + - Policies - SMB Client + summary: POST smb-client-policies + description: Create a new SMB Client policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmbClientPolicyPost' + required: false + x-codegen-request-body-name: policy + 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/SmbClientPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - SMB Client + summary: DELETE smb-client-policies + description: Delete one or more SMB Client policies. + 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: + - Policies - SMB Client + summary: PATCH smb-client-policies + description: Modify an existing SMB Client policy's attributes. + 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/SmbClientPolicyPatch' + required: true + x-codegen-request-body-name: policy + 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/SmbClientPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/smb-client-policies/rules: + get: + tags: + - Policies - SMB Client + summary: GET smb-client-policies/rules + description: 'Displays a list of SMB Client policy rules. + + The default sort is by policy name, then index. + + ' + 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/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/SmbClientPolicyRuleGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SmbClientPolicyRuleGetResponse' + post: + tags: + - Policies - SMB Client + summary: POST smb-client-policies/rules + description: 'Add an SMB Client policy rule. + + Rules are ordered in three groups; ip addresses, other and `*`. + + The new rule will be added at the end of the appropriate group if neither + + `before_rule_id` nor `before_rule_name` are specified. + + Rules can only be inserted into the appropriate group. + + The `policy_ids` or `policy_names` parameter is required, but they cannot + be + + set together. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmbClientPolicyRulePost' + 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/SmbClientPolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - SMB Client + summary: DELETE smb-client-policies/rules + description: 'Delete one or more SMB Client policy rules. + + One of the following is required: `ids` or `names`. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Policies - SMB Client + summary: PATCH smb-client-policies/rules + description: 'Modify an existing SMB Client policy rule. + + If `before_rule_id` or `before_rule_name` are specified, the rule will be + + moved before that rule. + + Rules are ordered in three groups; ip addresses, other and `*` and can only + + be moved within the appropriate group. + + One of the following is required: `ids` or `names`. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Before_rule_id' + - $ref: '#/components/parameters/Before_rule_name' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Versions' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmbClientPolicyRule' + 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/SmbClientPolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/smb-share-policies: + get: + tags: + - Policies - SMB Share + summary: GET smb-share-policies + description: Display SMB Share policies 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/Workload_ids' + - $ref: '#/components/parameters/Workload_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/SmbSharePolicyGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SmbSharePolicyGetResponse' + post: + tags: + - Policies - SMB Share + summary: POST smb-share-policies + description: Create a new SMB Share policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmbSharePolicyPost' + required: false + x-codegen-request-body-name: policy + 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/SmbSharePolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - SMB Share + summary: DELETE smb-share-policies + description: Delete one or more SMB Share policies. + 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: + - Policies - SMB Share + summary: PATCH smb-share-policies + description: Modify an existing SMB Share policy's attributes. + 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/SmbSharePolicyPatch' + required: true + x-codegen-request-body-name: policy + 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/SmbSharePolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/smb-share-policies/rules: + get: + tags: + - Policies - SMB Share + summary: GET smb-share-policies/rules + description: 'Displays a list of SMB Share policy rules. + + ' + 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/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + - $ref: '#/components/parameters/Sort' + 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/SmbSharePolicyRuleGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SmbSharePolicyRuleGetResponse' + post: + tags: + - Policies - SMB Share + summary: POST smb-share-policies/rules + description: 'Add an SMB Share policy rule. + + The `policy_ids` or `policy_names` parameter is required, but they cannot + be + + set together. + + ' + parameters: + - $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/SmbSharePolicyRulePost' + 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/SmbSharePolicyRuleResponse' + x-codegen-request-body-name: rule + delete: + tags: + - Policies - SMB Share + summary: DELETE smb-share-policies/rules + description: 'Delete one or more SMB Share policy rules. + + One of the following is required: `ids` or `names`. + + If `names` is provided, the `policy_ids` or `policy_names` parameter is also + required. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/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: {} + patch: + tags: + - Policies - SMB Share + summary: PATCH smb-share-policies/rules + description: 'Modify an existing SMB Share policy rule. + + One of the following is required: `ids` or `names`. + + If `names` is provided, the `policy_ids` or `policy_names` parameter is also + required. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Policy_ids' + - $ref: '#/components/parameters/Policy_names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmbSharePolicyRule' + 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/SmbSharePolicyRuleResponse' + x-codegen-request-body-name: rule + /api/2.23/smtp-servers: + get: + tags: + - SMTP + summary: GET smtp-servers + description: List SMTP server attributes for the array network. + parameters: + - $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' + 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/SmtpServerGetResponse' + patch: + tags: + - SMTP + summary: PATCH smtp-servers + description: Modify SMTP server attributes such as the relay host and sender + domain. + parameters: + - $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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SmtpServerResponse' + x-codegen-request-body-name: smtp + /api/2.23/snmp-agents: + get: + tags: + - SNMP Agents + summary: GET snmp-agents + description: List SNMP agent attributes. + parameters: + - $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' + 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/SnmpAgentGetResponse' + patch: + tags: + - SNMP Agents + summary: PATCH snmp-agents + description: Modify SNMP agent attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnmpAgent' + required: true + x-codegen-request-body-name: snmp-agent + 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/SnmpAgentResponse' + x-codegen-request-body-name: snmp-agent + /api/2.23/snmp-agents/mib: + get: + tags: + - SNMP Agents + summary: GET snmp-agents-mib + description: 'List the SNMP MIB text. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SnmpAgentMibResponse' + /api/2.23/snmp-managers: + get: + tags: + - SNMP Managers + summary: GET snmp-managers + description: List SNMP managers and their attributes. + parameters: + - $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' + 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/SnmpManagerGetResponse' + post: + tags: + - SNMP Managers + summary: POST snmp-managers + description: Create an SNMP manager. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnmpManagerPost' + required: true + x-codegen-request-body-name: snmp-manager + 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/SnmpManagerResponse' + x-codegen-request-body-name: snmp-manager + delete: + tags: + - SNMP Managers + summary: DELETE snmp-managers + description: Remove an SNMP manager. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - SNMP Managers + summary: PATCH snmp-managers + description: Modify SNMP manager attributes such as versions. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SnmpManager' + required: true + x-codegen-request-body-name: snmp-manager + 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/SnmpManagerResponse' + x-codegen-request-body-name: snmp-manager + /api/2.23/snmp-managers/test: + get: + tags: + - SNMP Managers + summary: GET snmp-managers/test + description: Test if the configuration of an SNMP manager is valid. + parameters: + - $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' + 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/TestResultGetResponse' + /api/2.23/ssh-certificate-authority-policies: + get: + tags: + - Policies - SSH Certificate Authority + summary: List SSH Certificate Authority configurations + description: List SSH Certificate Authority configurations + parameters: + - $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' + 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/SshCertificateAuthorityPolicyGetResponse' + post: + tags: + - Policies - SSH Certificate Authority + summary: Create SSH Certificate Authority configurations + description: Creates SSH Certificate Authority configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SshCertificateAuthorityPolicyPost' + required: true + x-codegen-request-body-name: policy + 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/SshCertificateAuthorityPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - SSH Certificate Authority + summary: Delete SSH Certificate Authority configurations + description: Deletes SSH Certificate Authority configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Policies - SSH Certificate Authority + summary: Modify SSH Certificate Authority configurations + description: Modifies one or more attributes of SSH Certificate Authority configurations. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SshCertificateAuthorityPolicy' + required: true + x-codegen-request-body-name: policy + 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/SshCertificateAuthorityPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/ssh-certificate-authority-policies/admins: + get: + tags: + - Policies - SSH Certificate Authority + summary: GET ssh-certificate-authority-policies/admins + description: List SSH Certificate Authority policies mapped to specific users. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - SSH Certificate Authority + summary: POST ssh-certificate-authority-policies/admins + description: Map a SSH Certificate Authority policy to a specific user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - SSH Certificate Authority + summary: DELETE ssh-certificate-authority-policies/admins + description: Remove a SSH Certificate Authority policy from a specific user. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/ssh-certificate-authority-policies/arrays: + get: + tags: + - Policies - SSH Certificate Authority + summary: GET ssh-certificate-authority-policies/arrays + description: List SSH Certificate Authority policies mapped as defaults for + admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - SSH Certificate Authority + summary: POST ssh-certificate-authority-policies/arrays + description: Map a SSH Certificate Authority policy as a default for admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - SSH Certificate Authority + summary: DELETE ssh-certificate-authority-policies/arrays + description: Remove a SSH Certificate Authority policy from being a default + for admins. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/ssh-certificate-authority-policies/members: + get: + tags: + - Policies - SSH Certificate Authority + summary: GET ssh-certificate-authority-policies/members + description: List SSH Certificate Authority policies mapped to the admin default + settings, or to one or more specific users. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + /api/2.23/subnets: + get: + tags: + - Subnets + summary: GET subnets + description: "List the array\u2019s subnets." + parameters: + - $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' + 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/SubnetGetResponse' + post: + tags: + - Subnets + summary: POST subnets + description: Create an array subnet. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Subnet' + required: true + x-codegen-request-body-name: subnet + 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/SubnetResponse' + x-codegen-request-body-name: subnet + delete: + tags: + - Subnets + summary: DELETE subnets + description: Remove an array subnet. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Subnets + summary: PATCH subnets + description: Modify array subnet attributes. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Subnet' + required: true + x-codegen-request-body-name: subnet + 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/SubnetResponse' + x-codegen-request-body-name: subnet + /api/2.23/support: + get: + tags: + - Support + summary: GET support + description: List Phone Home, Remote Assistance and Edge Management settings. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + application/json: + schema: + $ref: '#/components/schemas/SupportGetResponse' + patch: + tags: + - Support + summary: PATCH support + description: Modify Phone Home, Remote Assistance and Edge Management settings. + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Support' + required: true + x-codegen-request-body-name: support + 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/SupportResponse' + x-codegen-request-body-name: support + /api/2.23/support/test: + get: + tags: + - Support + summary: GET support-test + description: Test if the Phone Home and Remote Assistance settings are functioning + properly. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Test_type' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TestResultGetResponse' + /api/2.23/support/verification-keys: + get: + tags: + - Verification Keys + summary: GET verification-keys + description: 'List the key used to verify the signed challenges that are used + by Pure Support + + to access the FlashBlade. + + ' + parameters: + - $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' + 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/VerificationKeyGetResponse' + patch: + tags: + - Verification Keys + summary: PATCH verification-keys + description: 'Update the key used to verify the signed challenges that are used + by Pure Support + + to access the FlashBlade. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerificationKeyPatch' + required: true + x-codegen-request-body-name: 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/VerificationKeyResponse' + x-codegen-request-body-name: key + /api/2.23/support-diagnostics: + get: + tags: + - Support Diagnostics + summary: GET diagnostics list + description: 'Lists the support diagnostics tasks. + + ' + parameters: + - $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' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SupportDiagnosticsGetResponse' + post: + tags: + - Support Diagnostics + summary: Start a diagnostic task + description: 'Creates a diagnostics task for a given time interval. + + If `start_time` is not provided, defaults to Current System Time - 1 hour. + + If `end_time` is not provided, defaults to Current System Time. + + If a task is already running, an error is returned. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Analysis_period_end_time' + - $ref: '#/components/parameters/Analysis_period_start_time' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SupportDiagnosticsGetResponse' + '403': + description: Another instance is already running + content: {} + /api/2.23/support-diagnostics/details: + get: + tags: + - Support Diagnostics + summary: GET diagnostics details + description: 'Lists the diagnostics tasks details. + + ' + parameters: + - $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' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SupportDiagnosticsDetailsGetResponse' + /api/2.23/software-check: + get: + tags: + - Software + summary: List software check tasks + description: Displays a list of software check tasks. + parameters: + - $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: Create a software check task + description: 'Creates a software check task. + + To create a task, use a software name and version. + + If a task is already running, an error is returned. + + ' + parameters: + - $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' + '403': + description: Another instance is already running + content: {} + /api/2.23/syslog-servers: + get: + tags: + - Syslog + summary: GET syslog-servers + description: Return a list of configured syslog servers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Allow_errors' + - $ref: '#/components/parameters/Context_names_get' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names_for_syslog' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/SyslogServerGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerGetResponse' + post: + tags: + - Syslog + summary: POST syslog-servers + description: 'Configure a new syslog server. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_for_syslog' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerPost' + required: true + x-codegen-request-body-name: syslog-server + responses: + '200': + description: Returns the newly configured syslog server. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerResponse' + x-codegen-request-body-name: syslog-server + delete: + tags: + - Syslog + summary: DELETE syslog-servers + description: 'Delete a configured syslog server and stop forwarding syslog messages. + + ' + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names_for_syslog' + responses: + '200': + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: {} + patch: + tags: + - Syslog + summary: PATCH syslog-servers + description: Modify the URI or services of a configured syslog server. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names_for_syslog' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerPatch' + required: true + x-codegen-request-body-name: syslog-server + responses: + '200': + description: Returns the newly updated syslog server. + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerResponse' + x-codegen-request-body-name: syslog-server + /api/2.23/syslog-servers/settings: + get: + tags: + - Syslog + summary: GET syslog-servers/settings + description: List the certificate or certificate group associated with the syslog + servers. + parameters: + - $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' + 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/SyslogServerSettingsGetResponse' + patch: + tags: + - Syslog + summary: PATCH syslog-servers/settings + description: Modify the certificate or certificate group associated with the + syslog servers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SyslogServerSettings' + required: true + x-codegen-request-body-name: syslog-server-settings + 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/SyslogServerSettingsResponse' + x-codegen-request-body-name: syslog-server-settings + /api/2.23/syslog-servers/test: + get: + tags: + - Syslog + summary: GET syslog-servers/test + description: Send test messages to conifgured remote syslog servers. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + 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/TestResultGetResponse' + /api/2.23/targets: + get: + tags: + - Targets + summary: GET targets + description: List targets used for replication. + 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' + 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/TargetGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/TargetGetResponse' + post: + tags: + - Targets + summary: POST targets + description: Add a target for replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TargetPost' + required: true + x-codegen-request-body-name: target + 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/TargetResponse' + x-codegen-request-body-name: target + delete: + tags: + - Targets + summary: DELETE targets + description: Delete the connection to the target for replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Targets + summary: PATCH targets + description: Modify the target attributes for replication. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Target' + required: true + x-codegen-request-body-name: target + 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/TargetResponse' + x-codegen-request-body-name: target + /api/2.23/targets/performance/replication: + get: + tags: + - Targets + summary: GET targets/performance/replication + description: List replication performance metrics for targets. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/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/Resolution' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Start_time' + - $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/ResourcePerformanceReplicationGetResponse' + /api/2.23/tls-policies: + get: + tags: + - Policies - TLS + summary: List TLS policies + description: List TLS policies + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Continuation_token' + - $ref: '#/components/parameters/Effective_tls_policy' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Purity_defined' + - $ref: '#/components/parameters/Sort' + 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/TlsPolicyGetResponse' + post: + tags: + - Policies - TLS + summary: Create TLS policies + description: Creates TLS policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TlsPolicyPost' + required: true + x-codegen-request-body-name: policy + 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/TlsPolicyResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - TLS + summary: Delete TLS policies + description: Deletes TLS policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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: + - Policies - TLS + summary: Modify TLS policies + description: Modifies one or more attributes of TLS policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Ids' + - $ref: '#/components/parameters/Names' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TlsPolicy' + required: true + x-codegen-request-body-name: policy + 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/TlsPolicyResponse' + x-codegen-request-body-name: policy + /api/2.23/tls-policies/members: + get: + tags: + - Policies - TLS + summary: GET tls-policies/members + description: List TLS policies mapped to the array as a whole, or to one or + more specific objects on the array (such as network interfaces). + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + /api/2.23/tls-policies/network-interfaces: + get: + tags: + - Policies - TLS + summary: GET tls-policies/network-interfaces + description: List network interface TLS policies. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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' + 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/PolicyMemberGetResponse' + post: + tags: + - Policies - TLS + summary: POST tls-policies/network-interfaces + description: Apply a TLS policy to a specific network interface. A given network + interface may only have 1 TLS policy applied to it at any given time. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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/PolicyMemberResponse' + delete: + tags: + - Policies - TLS + summary: DELETE tls-policies/network-interfaces + description: Remove a TLS policy from a network interface. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $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.23/usage/groups: + get: + tags: + - Usage + summary: GET usage/groups + description: List groups with hard limit quotas and their file system 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/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Gids' + - $ref: '#/components/parameters/Group_names' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/GroupQuotaGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/GroupQuotaGetResponse' + /api/2.23/usage/users: + get: + tags: + - Usage + summary: GET usage/users + description: List users with hard limit quotas and their file system 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/File_system_ids' + - $ref: '#/components/parameters/File_system_names' + - $ref: '#/components/parameters/Filter' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + - $ref: '#/components/parameters/Uids' + - $ref: '#/components/parameters/User_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/UserQuotaGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/UserQuotaGetResponse' + /api/2.23/workloads: + get: + tags: + - Workloads + summary: List workloads + description: 'Displays a list of workloads. + + ' + 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/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: Create a workload + description: 'Creates one workload. + + ' + parameters: + - $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: 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/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: 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/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.23/workloads/placement-recommendations: + get: + tags: + - Workloads + summary: List workload placement recommendations + description: Displays a list of placement recommendations for workloads. + parameters: + - $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: 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/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.23/workloads/tags: + get: + tags: + - Workloads + summary: List tags + description: Displays the list of tags. + parameters: + - $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: Delete tags + description: Deletes specified tags. + parameters: + - $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.23/workloads/tags/batch: + put: + tags: + - Workloads + summary: Update tags + description: Updates or creates tags for all specified objects. + parameters: + - $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 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 + /api/2.23/worm-data-policies: + get: + tags: + - Policies - WORM Data + summary: GET worm-data-policies + description: List WORM data 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/Ids' + - $ref: '#/components/parameters/Limit' + - $ref: '#/components/parameters/Names' + - $ref: '#/components/parameters/Offset' + - $ref: '#/components/parameters/Sort' + 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/WormDataPoliciesGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/WormDataPoliciesGetResponse' + post: + tags: + - Policies - WORM Data + summary: POST worm-data-policies + description: Create a WORM data policy. + parameters: + - $ref: '#/components/parameters/XRequestId' + - $ref: '#/components/parameters/Context_names' + - $ref: '#/components/parameters/Names_required' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/WormDataPolicy' + required: false + x-codegen-request-body-name: policy + 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/WormDataPoliciesResponse' + x-codegen-request-body-name: policy + delete: + tags: + - Policies - WORM Data + summary: DELETE worm-data-policies + description: 'Delete a WORM data policy. + + Deletion is not allowed if the policy is attached to one or more file systems. + + ' + 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: + - Policies - WORM Data + summary: PATCH worm-data-policies + description: Modify a WORM data policy. + 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/WormDataPolicy' + required: false + x-codegen-request-body-name: policy + 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/WormDataPoliciesResponse' + x-codegen-request-body-name: policy + /api/2.23/worm-data-policies/members: + get: + tags: + - Policies - WORM Data + summary: GET worm-data-policies/members + description: List members mapped to a WORM data policy. + 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' + 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/WormDataPoliciesMembersGetResponse' + '207': + description: 'Partial success. Some resources were returned, but there + + were also errors possibly preventing some resources from + + being returned. + + ' + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/WormDataPoliciesMembersGetResponse' + /oauth2_pub_priv_key_pair: + get: + description: "Returns a public and private key pair, This is not part of the + FlashArray API, \nit's a helper endpoint making it easier to generate an oauth2 + token_id in this Swagger UI. \nThey keys are generated in the Docker container + running on this machine.\n\nRecommend to NOT use this API but to use OpenSSL + instead for production use cases:\n You can generate a public and private + RSA key pair like this:\n\n openssl genrsa -des3 -out private.pem 2048\n + \ \n That generates a 2048-bit RSA key pair, encrypts them with a password + you provide and writes them to a file. \n You need to next extract the + public key file. You will use this, for instance, on your web server to encrypt + \n content so that it can only be read with the private key.\n \n Export + the RSA Public Key to a File\n This is a command that is\n \n openssl + rsa -in private.pem -outform PEM -pubout -out public.pem" + responses: + '200': + description: Token Generated + content: + application/json: + schema: + type: object + properties: + private_key: + type: string + description: Private key in PEM format. + public_key: + type: string + description: Public key in PEM format. + tags: + - Auth Helpers + /oauth2_token_from_private_key: + post: + description: "Authenticates to Flasharray, This returns a token_id (think session + id), from an existing API Client, \nThis is not part of the FlashArray API, + it's a helper endpoint making it easy to generate an \noauth2 token_id in + this Swagger UI. The private key is being passed into the Docker container + in\norder to sign the JWT token. Take a look at the Docker container output + to see more details \nof what is happening.\n\nCopy the output value, Authorization + header, and then click on the green Authorize button at the \ntop of the page. + \ Paste in the value into" + responses: + '200': + description: Token Generated + content: + application/json: + schema: + type: object + properties: + Authorization: + type: string + description: An OAuth bearer token to be used in the Authorization + header for authorization to API endpoints. + description: + type: string + description: How to use token + example: + username: pureuser + x-codegen-request-body-name: private_key + tags: + - Auth Helpers + parameters: + - name: issuer_name + in: header + schema: + type: string + description: Issuer value displayed in the FlashArray API Registration page + or pureapiclient list ) by default it's the same name as API Client + - name: client_id + in: header + schema: + type: string + description: Client Id value displayed in the FlashArray API Registration + page or pureapiclient list + - name: key_id + in: header + schema: + type: string + description: Key Id value displayed in the FlashArray API Registration page + or pureapiclient list + - name: username + in: header + schema: + type: string + description: The name of a valid user on the FlashArray that will be authenticated + to. + requestBody: + description: Private key in PEM format that was used to create the Public + key for this API Client specified as the issuer in this call. + content: + text/plain: + schema: + type: string + required: true +components: + securitySchemes: + AuthorizationHeader: + type: apiKey + name: x-auth-token + in: header + ApiToken: + type: apiKey + name: api-token + in: header + 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_version: + type: object + properties: + versions: + $ref: '#/components/schemas/_api_versions' + Login: + type: object + properties: + username: + description: The username of the user. + type: string + example: pureuser + LoginBannerGetResponse: + type: object + properties: + login_banner: + description: The string to show as login banner. + type: string + example: Restricted area. Authorized personnel only. + ActiveDirectoryPost: + allOf: + - $ref: '#/components/schemas/ActiveDirectoryDirectoryServers' + - type: object + required: + - domain + - password + - user + properties: + computer_name: + description: 'The common 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: FLASHBLADE01 + directory_servers: + description: 'A list of directory servers that will be used for lookups + related to user authorization. + + Accepted server formats are IP address and DNS name. + + All specified servers must be registered to the domain appropriately + in the array''s + + configured DNS and will only be communicated with over the secure LDAP + (LDAPS) protocol. + + If not specified, servers are resolved for the domain in DNS. + + The specified list can have a maximum length of 5. + + ' + type: array + maxItems: 5 + items: + type: string + example: ldap.my-corporation.com + domain: + description: The Active Directory domain to join. + type: string + example: my-corporation.com + encryption_types: + description: 'The encryption types that will be supported for use by clients + for Kerberos + + authentication. + + Defaults to `aes256-cts-hmac-sha1-96`. + + Valid values include `aes256-cts-hmac-sha1-96`, `aes128-cts-hmac-sha1-96`, + and + + `arcfour-hmac`. + + Cannot be provided if using an existing machine account. + + ' + type: array + items: + type: string + example: aes256-cts-hmac-sha1-96 + fqdns: + description: 'A list of fully qualified domain names to use to register + service principal + + names for the machine account. If specified, every service principal + that + + is supported by the array will be registered for each fully qualified + domain + + name specified. If neither `fqdns` nor `service_principal_names` is + specified, + + the default `service_principal_names` are constructed using + + the `computer_name` and `domain` fields. + + Cannot be provided in combination with `service_principal_names`. + + Cannot be provided if using an existing machine account. + + ' + type: array + maxItems: 32 + items: + type: string + example: vip1.my-array.my-corporation.com + join_ou: + description: 'The relative distinguished name of the organizational unit + in which the + + computer account should be created when joining the domain. + + Cannot be provided if using an existing machine account. + + If not specified, defaults to `CN=Computers`. + + ' + type: string + example: CN=Computers + kerberos_servers: + description: 'A list of key distribution servers to use for Kerberos protocol. + + Accepted server formats are IP address and DNS name. + + All specified servers must be registered to the domain appropriately + in the array''s + + configured DNS. + + If not specified, servers are resolved for the domain in DNS. + + The specified list can have a maximum length of 5. + + ' + type: array + maxItems: 5 + 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. If using an existing computer account, the user must + have privileges to + + read attributes from the computer account and reset the password on + that account. + + This is not persisted on the array. + + ' + type: string + example: Anything#but$adMinistrat0r + service_principal_names: + description: 'A list of service principal names to register for the machine + account, + + which can be used for the creation of keys for Kerberos authentication. + + If neither `service_principal_names` nor `fqdns` is specified, + + the default `service_principal_names` are constructed using + + the `computer_name` and `domain` fields. + + Cannot be provided in combination with `fqdns`. + + Cannot be provided if using an existing machine account. + + ' + type: array + maxItems: 32 + items: + pattern: (service)/(fqdn) + type: string + example: nfs/vip1.my-array.my-corporation.com + user: + description: 'The login name of the user with privileges to create the + computer account in + + the domain. If using an existing computer account, the user must have + privileges to + + read attributes from the computer account and reset the password on + that account. + + This is not persisted on the array. + + ' + type: string + example: Administrator + ActiveDirectoryPatch: + allOf: + - $ref: '#/components/schemas/ActiveDirectoryDirectoryServers' + - type: object + properties: + directory_servers: + description: 'A list of directory servers that will be used for lookups + related to user authorization. + + Accepted server formats are IP address and DNS name. + + All specified servers must be registered to the domain appropriately + in the array''s + + configured DNS and will only be communicated with over the secure LDAP + (LDAPS) protocol. + + If not specified, servers are resolved for the domain in DNS. + + The specified list can have a maximum length of 5. + + ' + type: array + maxItems: 5 + items: + type: string + example: ldap.my-corporation.com + encryption_types: + description: 'The encryption types that will be supported for use by clients + for Kerberos + + authentication. + + Valid values include `aes256-cts-hmac-sha1-96`, `aes128-cts-hmac-sha1-96`, + and + + `arcfour-hmac`. + + ' + type: array + items: + type: string + example: aes256-cts-hmac-sha1-96 + fqdns: + description: 'A list of fully qualified domain names to use to register + service principal + + names for the machine account. If specified, every service principal + that + + is supported by the array will be registered for each fully qualified + domain + + name specified. If neither `fqdns` nor `service_principal_names` is + specified, + + the default `service_principal_names` are constructed using + + the `computer_name` and `domain` fields. + + Cannot be provided in combination with `service_principal_names`. + + ' + type: array + maxItems: 32 + items: + type: string + example: vip1.my-array.my-corporation.com + join_ou: + description: 'The relative distinguished name of the organizational unit + in which the + + computer account should be created when joining the domain. + + ' + type: string + example: OU=Purestorage,OU=StorageMachines + kerberos_servers: + description: 'A list of key distribution servers to use for Kerberos protocol. + + Accepted server formats are IP address and DNS name. + + All specified servers must be registered to the domain appropriately + in the array''s + + configured DNS. + + If not specified, servers are resolved for the domain in DNS. + + The specified list can have a maximum length of 5. + + ' + type: array + maxItems: 5 + items: + type: string + example: kdc.my-corporation.com + service_principal_names: + description: 'A list of service principal names to register for the machine + account, + + which can be used for the creation of keys for Kerberos authentication. + + If neither `service_principal_names` nor `fqdns` is specified, + + the default `service_principal_names` are constructed using + + the `computer_name` and `domain` fields. + + Cannot be provided in combination with `fqdns`. + + ' + type: array + maxItems: 32 + items: + pattern: (service)/(fqdn) + type: string + example: nfs/vip1.my-array.my-corporation.com + 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' + TestResultRemoteExecutionGet: + allOf: + - $ref: '#/components/schemas/TestResultRemoteExecution' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + total_item_count: + description: Total number of items after applying `filter` params. + type: integer + format: int32 + AdminPost: + description: 'An administrative user, who has rights to login and manage the + array in some capacity. + + ' + type: object + properties: + management_access_policies: + description: 'List of management access policies associated with the administrator. + + ' + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + password: + description: New user password. + type: string + public_key: + description: Public key for SSH access. Supported key types include `Ed25519` + and `RSA`. + type: string + role: + description: 'Deprecated. + + `role` is deprecated in favor of `management_access_policies`, but remains + for + + backwards compatibility. If an administrator has exactly one access policy + which + + corresponds to a valid legacy role of the same name, `role` will be a + + reference to that role. + + Otherwise, it will be `null`. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + AdminPatch: + type: object + properties: + locked: + description: 'If set to `false`, the specified user is unlocked. + + Setting to `true` is not allowed. + + ' + type: boolean + example: false + old_password: + description: Old user password. + type: string + password: + description: New user password. + type: string + public_key: + description: Public key for SSH access. Supported key types are `Ed25519` + and `RSA`. + type: string + role: + description: 'Deprecated. + + `role` is deprecated in favor of `management_access_policies`, but remains + for + + backwards compatibility. If an administrator has exactly one access policy + which + + corresponds to a valid legacy role of the same name, `role` will be a + + reference to that role. + + Otherwise, it will be `null`. If `role` is `null`, then attempts to patch + it + + will fail in order to prevent legacy operations from overwriting administrator + + configurations utilizing newer policies. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + AdminGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AdminResponse' + - $ref: '#/components/schemas/_errorContextResponse' + AdminResponse: + type: object + properties: + items: + description: A list of administrative account objects. + type: array + items: + $ref: '#/components/schemas/Admin' + AdminApiTokenGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AdminApiTokenResponse' + AdminApiTokenResponse: + type: object + properties: + items: + description: A list of administrator API tokens. + type: array + items: + $ref: '#/components/schemas/AdminApiToken' + AdminCacheGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of admin cache entries. + type: array + items: + $ref: '#/components/schemas/AdminCache' + PolicyMemberGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyMemberResponse' + PolicyMemberResponse: + type: object + properties: + items: + description: A list of members for policies. + type: array + items: + $ref: '#/components/schemas/PolicyMember' + PolicyMemberContextGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyMemberContextResponse' + - $ref: '#/components/schemas/_errorContextResponse' + PolicyMemberContextResponse: + type: object + properties: + items: + description: A list of members for policies. + type: array + items: + $ref: '#/components/schemas/PolicyMemberContext' + AdminSetting: + type: object + properties: + lockout_duration: + description: 'The lockout duration, in milliseconds, if a user has reached + the + + maximum number of login attempts. Ranges from 1 second to 90 days. + + Default value is `null`. Use 0 to reset the value to `null`. + + ' + type: integer + format: int64 + minimum: 0 + maximum: 7776000000 + example: 3600000 + max_login_attempts: + description: 'The maximum number of failed login attempts allowed before + the user is locked out. + + Default value is `null`. Use 0 to reset the value to `null`. + + ' + type: integer + format: int32 + minimum: 0 + maximum: 100 + example: 10 + min_password_length: + description: 'The minimum password length. If not specified, defaults to + 1 character. + + ' + type: integer + format: int32 + minimum: 1 + maximum: 100 + example: 1 + AdminSettingsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AdminSettingsResponse' + AdminSettingsResponse: + type: object + properties: + items: + description: Returns global admin settings. + type: array + items: + $ref: '#/components/schemas/AdminSetting' + Alert: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + action: + description: The action of the alert. + type: string + readOnly: true + code: + description: Alert code. + type: integer + format: int64 + readOnly: true + component_name: + description: The component name of the alert. + type: string + readOnly: true + component_type: + description: The component type of the alert. + type: string + readOnly: true + created: + description: The creation timestamp of the alert. + type: integer + format: int64 + readOnly: true + description: + description: The description of the alert. + type: string + readOnly: true + duration: + description: The duration of the alert. + type: integer + format: int64 + readOnly: true + flagged: + description: Flagged state of the alert. + type: boolean + index: + description: The unique index of the alert. + type: integer + format: int64 + readOnly: true + knowledge_base_url: + description: URL of the relevant Knowledge Base page. + type: string + readOnly: true + notified: + description: The last notification timestamp of the alert. + type: integer + format: int64 + readOnly: true + severity: + description: 'Severity of the alert. + + Valid values are `info`, `warning`, and `critical`. + + ' + type: string + readOnly: true + state: + description: 'The current state of the alert. + + Valid values are `open`, `closing`, `closed`, and + + `waiting to downgrade`. + + ' + type: string + readOnly: true + summary: + description: The summary of the alert. + type: string + readOnly: true + updated: + description: The last updated timestamp of the alert. + type: integer + format: int64 + readOnly: true + variables: + description: Key-value pairs of additional information of the alert. + type: object + readOnly: true + additionalProperties: + type: string + AlertGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AlertResponse' + AlertResponse: + type: object + properties: + items: + description: A list of alert objects. + type: array + items: + $ref: '#/components/schemas/Alert' + AlertWatcherPost: + type: object + properties: + minimum_notification_severity: + description: 'The minimum severity that an alert must have in order for + emails to + + be sent to the watcher. + + Possible values include `info`, `warning`, and `critical`. + + If not specified, defaults to `info`. + + ' + type: string + AlertWatcher: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + enabled: + description: 'Is email notification enabled? If not specified, defaults + to `true`. + + ' + type: boolean + minimum_notification_severity: + description: 'The minimum severity that an alert must have in order for + emails to + + be sent to the watcher. + + Possible values include `info`, `warning`, and `critical`. + + ' + type: string + 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' + TestResultResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/TestResult' + ApiClientsPost: + type: object + required: + - public_key + 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/_referenceWritable' + access_token_ttl_in_ms: + description: 'The TTL (Time To Live) duration for which the exchanged access + token is valid. + + 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 a client has exactly one access policy which corresponds + to a + + valid legacy role of the same name, `max_role` will be a reference to + that role. + + Otherwise, it will be `null`. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + public_key: + description: 'The API client''s PEM formatted (Base64 encoded) RSA public + key. + + It must 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----- + + ' + ApiClient: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: 'API client used for OAuth. + + ' + 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/_fixedReference' + readOnly: true + access_token_ttl_in_ms: + description: 'The TTL (Time To Live) duration for which the exchanged + access token is valid. + + 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 + example: true + 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: http://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: '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 a reference to + that role. + + Otherwise, it will be `null`. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + 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----- + + ' + ApiClientsResponse: + type: object + properties: + items: + description: A list of API client objects. + type: array + items: + $ref: '#/components/schemas/ApiClient' + Array: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/_context' + - type: object + properties: + _as_of: + description: Array time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + banner: + description: 'A string to be shown when logging in to the array. + + ' + type: string + example: Restricted area. Authorized personnel only. + default_inbound_tls_policy: + description: 'The default TLS policy governing inbound traffic from clients + accessing the array. + + This TLS policy will be applied for any IP addresses on the system that + do not + + have a specific policy applied to them at a more granular level. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + encryption: + readOnly: true + title: ArrayEncryption + allOf: + - $ref: '#/components/schemas/_arrayEncryption' + eradication_config: + title: ArrayEradicationConfig + allOf: + - $ref: '#/components/schemas/_arrayEradicationConfig' + idle_timeout: + description: 'Idle timeout in milliseconds. Valid values are + + in the range of 300000 and 10800000. Setting this value to 0 + + disables timeouts. + + ' + type: integer + format: int32 + example: 300000 + network_access_policy: + description: 'The network access policy governing which clients are allowed + or denied access to different + + array interfaces. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + ntp_servers: + type: array + items: + type: string + example: time.acme.com + os: + description: 'Valid values are `Purity//FA` and `Purity//FB`. + + ' + type: string + readOnly: true + example: Purity//FB + product_type: + description: 'For `FlashBlade//S` arrays, the value is determined by the + blades in the system. + + The value will be `FlashBlade` for all older arrays. + + Valid values are `FlashBlade`, `FlashBlade//S`, `FlashBlade//S200`, + and `FlashBladeS500`. + + ' + type: string + readOnly: true + revision: + type: string + readOnly: true + example: 2017.11.07_8f3ab6f5 + security_update: + description: 'The name of the installed security update that currently + applies to the system. + + This field will be `null` if either no security update has been installed, + or if the + + most recently installed security update is no longer needed by the current + + FlashBlade software due to the current software fully incorporating + the update. + + ' + type: string + readOnly: true + example: fb-2022-04-04 + smb_mode: + description: 'The current SMB mode of the array. + + This controls the type of authentication that is used by the array for + SMB. + + Possible values include `ad-auto`, `ad-rfc2307`, `guest`, and `native`. + + Modifying this value requires the assistance of Pure Storage Support. + + ' + type: string + readOnly: true + time_zone: + description: 'The time zone to use for the array. In particular this affects + + the CLI formatting and the default snapshot policy time zone. + + ' + type: string + example: America/Los_Angeles + version: + type: string + readOnly: true + example: 2.1.0 + ArrayGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ArrayResponse' + - $ref: '#/components/schemas/_errorContextResponse' + ArrayResponse: + type: object + properties: + items: + description: A list of array objects. + type: array + items: + $ref: '#/components/schemas/Array' + ClientsPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of client performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ClientsPerformance' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no items will be returned. + + ' + type: array + items: + $ref: '#/components/schemas/ClientsPerformance' + - $ref: '#/components/schemas/_errorContextResponse' + ClientsS3SpecificPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of S3 specific array performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ClientsS3SpecificPerformance' + total: + description: Total of all records after filtering. If `total_only` query + param is `true`, then no items will be returned. + type: array + items: + $ref: '#/components/schemas/ClientsS3SpecificPerformance' + 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' + ArrayConnectionPost: + allOf: + - $ref: '#/components/schemas/ArrayConnection' + - type: object + properties: + connection_key: + description: 'The connection key of the target array. Settable on POST + only. + + ' + type: string + example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 + encrypted: + description: 'If this is set to `true`, then all customer data replicated + over + + the connection will be sent over an encrypted connection using TLS, + + or will not be sent if a secure connection cannot be + + established. + + If this is set to `false`, then all customer data replicated over + + the connection will be sent over an unencrypted connection. + + Defaults to `false`. + + ' + type: boolean + throttle: + $ref: '#/components/schemas/_throttle' + ArrayConnection: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - $ref: '#/components/schemas/_context' + - description: 'Connection to a target array. + + ' + type: object + properties: + ca_certificate_group: + description: 'The group of CA certificates that can be used, in addition + to + + well-known Certificate Authority certificates, in order to + + establish a secure connection to the target array. + + Defaults to a reference to the `_default_replication_certs` group + + if `secure_connection` is `true`, or `null` otherwise. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + encrypted: + description: 'If this is set to `true`, then all customer data replicated + over + + the connection will be sent over an encrypted connection using TLS, + + or will not be sent if a secure connection cannot be + + established. + + If this is set to `false`, then all customer data replicated over + + the connection will be sent over an unencrypted connection. + + Defaults to `false`. + + ' + type: boolean + management_address: + description: 'Management address of the target array. Settable on POST + only. + + ' + 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: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + replication_addresses: + description: 'IP addresses and/or FQDNs of the target arrays. Settable + on POST only. + + If not set on POST, 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 + status: + description: 'Status of the connection. + + Valid values include `connected`, `partially_connected`, `connecting`, + + and `incompatible`. + + `connected` - The connection is OK. + + `partially_connected` - Some replication addresses are working, + + but others are not. + + `connecting` - No connection exists and the array is trying to + + reconnect. + + `incompatible` - The target array is not compatible. + + ' + type: string + readOnly: true + throttle: + $ref: '#/components/schemas/_throttle' + type: + description: 'The type of connection. Valid values include `async-replication` + and `fleet-management`. + + ' + type: string + readOnly: true + version: + description: The version of the target array. + type: string + readOnly: true + example: 2.3.0 + 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' + - $ref: '#/components/schemas/ArrayConnectionKeyResponse' + ArrayConnectionKeyResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ArrayConnectionKey' + ArrayConnectionPathGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ArrayConnectionPath' + ConnectionRelationshipPerformanceReplicationGetResp: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ConnectionRelationshipPerformanceReplication' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no items will be returned. + + ' + type: array + items: + $ref: '#/components/schemas/ConnectionRelationshipPerformanceReplication' + ArrayHttpSpecificPerformanceGet: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + description: A list of http specific array performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ArrayHttpSpecificPerformance' + ArrayNfsSpecificPerformanceGet: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + description: A list of NFS specific array performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ArrayNfsSpecificPerformance' + ArrayPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + description: A list of array performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ArrayPerformance' + ArrayPerformanceReplicationGetResp: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/RelationshipPerformanceReplication' + ArrayS3SpecificPerformanceGetResp: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + description: A list of S3 specific array performance metrics objects. + type: array + items: + $ref: '#/components/schemas/ArrayS3SpecificPerformance' + ArraySpaceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + description: A list of array space metrics objects. + type: array + items: + $ref: '#/components/schemas/ArraySpace' + ArraySpaceStorageClassGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of array space metrics objects for each storage class. + type: array + items: + $ref: '#/components/schemas/StorageClassSpace' + total: + $ref: '#/components/schemas/StorageClassSpace' + ArraysSupportedTimeZonesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/_timeZone' + ArrayErasureResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ArrayErasure' + ArrayErasureGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ArrayErasureResponse' + AuditGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditResponse' + AuditFileSystemsPoliciesPost: + allOf: + - $ref: '#/components/schemas/AuditFileSystemsPolicyNoContext' + AuditFileSystemsPoliciesPatch: + allOf: + - $ref: '#/components/schemas/AuditFileSystemsPolicyPatchBase' + - type: object + properties: + add_log_targets: + description: 'The log targets which will be added to the existing `log_targets` + list for the + + audit policy. These new log targets will be appended to the end of the + existing list. + + The `add_log_targets` field can not be used with `log_targets` field. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + remove_log_targets: + description: 'The log targets which will be removed from the existing + `log_targets` list for the + + audit policy. The `remove_log_targets` field can not be used with `log_targets` + field. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + AuditFileSystemsPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditFileSystemsPoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + AuditFileSystemsPoliciesResponse: + type: object + properties: + items: + description: A list of audit policy objects. + type: array + items: + $ref: '#/components/schemas/AuditFileSystemsPolicy' + AuditFileSystemsPoliciesMembersGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditFileSystemsPoliciesMembersResponse' + - $ref: '#/components/schemas/_errorContextResponse' + AuditFileSystemsPoliciesMembersResponse: + type: object + properties: + items: + description: A list of members for audit policies. + type: array + items: + $ref: '#/components/schemas/PolicyMemberContext' + AuditFileSystemsPolicyOperationGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditFileSystemsPolicyOperationResponse' + AuditObjectStorePoliciesPost: + allOf: + - $ref: '#/components/schemas/AuditObjectStorePolicyWithWritableReference' + AuditObjectStorePoliciesPatch: + allOf: + - $ref: '#/components/schemas/AuditObjectStorePolicy' + - type: object + properties: + add_log_targets: + description: 'The log targets which will be added to the existing `log_targets` + list for the + + audit policy. These new log targets will be appended to the end of the + existing list. + + The `add_log_targets` field cannot be used with the `log_targets` field. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + remove_log_targets: + description: 'The log targets which will be removed from the existing + `log_targets` list for the + + audit policy. The `remove_log_targets` field cannot be used with the + `log_targets` field. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + AuditObjectStorePoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditObjectStorePoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + AuditObjectStorePoliciesResponse: + type: object + properties: + items: + description: A list of audit policy objects. + type: array + items: + $ref: '#/components/schemas/AuditObjectStorePolicyWithContext' + AuditObjectStorePoliciesMembersGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/AuditObjectStorePoliciesMembersResponse' + - $ref: '#/components/schemas/_errorContextResponse' + AuditObjectStorePoliciesMembersResponse: + type: object + properties: + items: + description: A list of members for audit object policies. + type: array + items: + $ref: '#/components/schemas/PolicyMemberContext' + BladeGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of blade objects. + type: array + items: + $ref: '#/components/schemas/Blade' + total: + type: object + allOf: + - $ref: '#/components/schemas/Blade' + - description: 'If `total_only` query param is `true`, then it 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 + BucketAuditFilterActionGetResponse: + allOf: + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/BucketAuditFilterActionResponse' + BucketPost: + type: object + properties: + account: + description: The account name for bucket creation. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + bucket_type: + description: 'The bucket type for the bucket. Valid values are `classic`, + and `multi-site-writable`. + + Default value is `multi-site-writable`. + + ' + type: string + eradication_config: + $ref: '#/components/schemas/_bucketEradicationConfig' + hard_limit_enabled: + description: 'If set to `true`, the bucket''s size, as defined by `quota_limit`, + + is used as a hard limit quota. + + If set to `false`, a hard limit quota will not be applied to the + + bucket, but soft quota alerts will still be sent if the bucket has + + a value set for `quota_limit`. + + If not specified, defaults to the value + + of `bucket_defaults.hard_limit_enabled` of the object store account this + + bucket is associated with. + + ' + type: boolean + object_lock_config: + $ref: '#/components/schemas/_objectLockConfigRequestBody' + quota_limit: + description: 'The effective quota limit applied against the size of the + bucket, displayed in bytes. + + If set to an empty string (`""`), the bucket is unlimited in size. If + not specified, + + defaults to the value of `bucket_defaults.quota_limit` of the object + + store account this bucket is associated with. + + ' + type: string + retention_lock: + description: 'If set to `ratcheted`, then `object_lock_config.default_retention_mode` + + cannot be changed if set to `compliance`. In this case, the value of + + `object_lock_config.default_retention` can only be increased and + + `object_lock_config.default_retention_mode` cannot be changed once set + + to `compliance`. + + Valid values are `unlocked` and `ratcheted`. + + If not specified, defaults to `unlocked`. + + ' + type: string + example: unlocked + BucketPatch: + type: object + properties: + destroyed: + description: 'Is the bucket destroyed? + + ' + type: boolean + eradication_config: + $ref: '#/components/schemas/_bucketEradicationConfig' + hard_limit_enabled: + description: 'If set to `true`, the bucket''s size, as defined by `quota_limit`, + + is used as a hard limit quota. + + If set to `false`, a hard limit quota will not be applied to the + + bucket, but soft quota alerts will still be sent if the bucket has + + a value set for `quota_limit`. + + ' + type: boolean + object_lock_config: + $ref: '#/components/schemas/_objectLockConfigRequestBody' + public_access_config: + $ref: '#/components/schemas/_publicAccessConfig' + qos_policy: + description: 'The QoS policy for the bucket defines the performance controls + + that can be applied to the aggregate performance of all the clients + + accessing the bucket. + + If no policy is set here, no explicit performance controls are applied + + to the bucket beyond the system''s default fairness. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + quota_limit: + description: 'The effective quota limit applied against the size of the + bucket, displayed in bytes. + + If set to an empty string (`""`), the bucket is unlimited in size. + + ' + type: string + retention_lock: + description: 'If set to `ratcheted`, then `object_lock_config.default_retention_mode` + + cannot be changed if set to `compliance`. In this case, the value of + + `object_lock_config.default_retention` can only be increased and + + `object_lock_config.default_retention_mode` cannot be changed once set + + to `compliance`. + + Valid values are `unlocked` and `ratcheted`. + + Contact Pure Technical Services to change `ratcheted` to `unlocked`. + + ' + type: string + example: unlocked + storage_class: + $ref: '#/components/schemas/StorageClassInfo' + versioning: + description: 'The versioning state for objects within the bucket. + + Valid values are `none`, `enabled`, and `suspended`. + + ' + type: string + BucketGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/BucketResponse' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + total: + $ref: '#/components/schemas/Bucket' + BucketResponse: + type: object + properties: + items: + description: A list of bucket objects. + type: array + items: + $ref: '#/components/schemas/Bucket' + BucketAuditFilterPost: + description: The audit filter object. + allOf: + - $ref: '#/components/schemas/BucketAuditFilterBase' + BucketAuditFilterGetResponse: + allOf: + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/BucketAuditFilterResponse' + BucketAuditFilterResponse: + type: object + properties: + items: + description: A list of audit filters. + type: array + items: + $ref: '#/components/schemas/BucketAuditFilterWithContext' + CrossOriginResourceSharingPolicyPatch: + type: object + properties: + rules: + type: array + items: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleBulkManage' + CrossOriginResourceSharingPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyResponse' + CrossOriginResourceSharingPolicyResponse: + type: object + properties: + items: + description: A list of cross origin resource sharing policy objects. + type: array + items: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicy' + CrossOriginResourceSharingPolicyRulePost: + type: object + properties: + allowed_headers: + description: 'A list of headers that are permitted to be included in cross-origin + requests to + + access a bucket. The only currently supported allowed header is `*`. + + ' + type: array + items: + type: string + example: + - '*' + allowed_methods: + description: 'A list of HTTP methods that are permitted for cross-origin + requests to access a bucket. + + The only currently supported combination of allowed methods is all methods + + `["GET", "PUT", "HEAD", "POST", "DELETE"]`. + + ' + type: array + items: + type: string + example: + - GET + - PUT + - HEAD + - POST + - DELETE + allowed_origins: + description: 'A list of origins (domains) that are permitted to make cross-origin + requests to + + access a bucket. The only currently supported allowed origin is `*`. + + ' + type: array + items: + type: string + example: + - '*' + CrossOriginResourceSharingPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleResponse' + CrossOriginResourceSharingPolicyRuleResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleWithContext' + BucketPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of bucket performance objects. + type: array + items: + $ref: '#/components/schemas/BucketPerformanceItems' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no items will be returned. + + ' + type: array + items: + $ref: '#/components/schemas/BucketPerformance' + BucketAccessPolicyPost: + type: object + properties: + rules: + type: array + items: + $ref: '#/components/schemas/BucketAccessPolicyRuleBulkManage' + BucketAccessPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/BucketAccessPolicyResponse' + BucketAccessPolicyResponse: + type: object + properties: + items: + description: A list of bucket policy objects. + type: array + items: + $ref: '#/components/schemas/BucketAccessPolicy' + BucketAccessPolicyRulePost: + type: object + properties: + actions: + description: 'The list of actions granted by this rule. Each included action + may + + restrict other properties of the rule. + + The only currently supported action is `s3:GetObject`. + + ' + type: array + items: + type: string + example: + - s3:GetObject + 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. + + The only currently supported effect is `allow`. + + ' + type: string + readOnly: true + example: allow + principals: + description: 'The principals to which this rule applies. Currently, only + all principals are supported. + + ' + title: BucketAccessPolicyRulePrincipal + allOf: + - $ref: '#/components/schemas/BucketAccessPolicyRulePrincipal' + resources: + description: 'The list of resources which this rule applies to. + + The only currently supported resource is all objects in a bucket to which + + the parent policy belongs. + + ' + type: array + items: + type: string + example: + - mybucket/* + BucketAccessPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/BucketAccessPolicyRuleResponse' + BucketAccessPolicyRuleResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/BucketAccessPolicyRuleWithContext' + BucketS3SpecificPerformanceGetResp: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of S3 specific bucket performance metrics objects. + type: array + items: + $ref: '#/components/schemas/BucketS3SpecificPerformance' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no items will be returned. + + ' + type: array + items: + $ref: '#/components/schemas/BucketS3SpecificPerformance' + BucketReplicaLinkPost: + type: object + properties: + cascading_enabled: + description: 'If set to `true`, objects replicated to this bucket via a + replica + + link from another array will also be replicated by this link to + + the remote bucket. + + Defaults to `false`. + + ' + type: boolean + paused: + description: Create link in the paused state? Defaults to `false`. + type: boolean + BucketReplicaLink: + allOf: + - $ref: '#/components/schemas/_replicaLinkBuiltIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + cascading_enabled: + description: 'If set to `true`, objects replicated to this bucket via + a replica + + link from another array will also be replicated by this link to + + the remote bucket. + + Defaults to `false`. + + ' + type: boolean + readOnly: true + local_bucket: + description: 'Reference to a local bucket. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + object_backlog: + description: 'The number of pending operations and their size that are + currently in the backlog. + + ' + title: ObjectBacklog + allOf: + - $ref: '#/components/schemas/_objectBacklog' + paused: + description: Is the replica link paused? + type: boolean + recovery_point: + description: 'Time, in milliseconds since UNIX epoch, where all object + changes before this time are + + guaranteed to have been replicated. Changes after this time may have + been replicated. + + ' + type: integer + format: int64 + readOnly: true + example: 1565034592494 + remote: + description: 'Reference to the associated remote, which can either be + a `target` or remote `array`. + + If it is an `array`, then the `resource-type` field will not be populated. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + remote_bucket: + description: Reference to a remote bucket. + title: FixedReferenceNameOnly + allOf: + - $ref: '#/components/schemas/_fixedReferenceNameOnly' + remote_credentials: + description: 'Reference to a remote-credentials object to access the remote + bucket. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + status: + description: 'Status of the replica link. + + Values include `replicating`, `paused`, and `unhealthy`. + + ' + type: string + readOnly: true + BucketReplicaLinkGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/BucketReplicaLinkResponse' + BucketReplicaLinkResponse: + type: object + properties: + items: + description: A list of object store bucket replica link objects. + type: array + items: + $ref: '#/components/schemas/BucketReplicaLink' + total: + description: 'If `total_only` query param is `true`, then it 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. + + ' + title: BucketReplicaLink + allOf: + - $ref: '#/components/schemas/BucketReplicaLink' + 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 + passphrase: + description: 'The passphrase used to encrypt `private_key`. + + This field can only be specified when importing a certificate and key + pair. + + ' + type: string + private_key: + description: 'The text of the private key. + + This field can only be specified when importing a certificate and key + pair. + + ' + type: string + CertificatePatch: + 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 + passphrase: + description: 'The passphrase used to encrypt `private_key`. + + This field can only be specified when importing a certificate and key + pair. + + ' + type: string + private_key: + description: 'The text of the private 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: + description: A list of certificate objects. + type: array + items: + $ref: '#/components/schemas/Certificate' + CertificateCertificateGroupGetResp: + 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/Member' + CertificateSigningRequestPost: + description: A request to create a CSR for a Purity//FB certificate object. + type: object + properties: + certificate: + description: 'The certificate object whose private key will be used for + generating the CSR, + + and whose certificate will be overwritten if the CSR is signed and + + imported back into FlashBlade. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + common_name: + description: The common name field to be listed in the certificate. + type: string + example: Pure Storage Inc. + country: + description: Two-letter country (ISO) code to be listed in the certificate. + type: string + example: CA + email: + description: The email field to be listed in the certificate. + type: string + example: tcrisp@veridiandynamics.com + locality: + description: The locality field to be listed in the certificate. + type: string + example: Toronto + organization: + description: The organization field to be listed in the certificate. + type: string + example: Veridian Dynamics + organizational_unit: + description: The organizational unit field to be listed in the certificate. + type: string + example: Research & Development + state: + description: The state/province field to be listed in the certificate. + type: string + example: Ontario + subject_alternative_names: + description: 'The alternative names that are secured by this certificate. + + Alternative names may be IP addresses, DNS names, or URIs. + + Specifying these will encode them in the certificate signing + + request; however, it is the decision of the signing authority + + as to whether or not they will be honored or ignored. + + ' + type: array + items: + type: string + example: otherdnsname.mydomain.com + CertificateSigningRequestResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/CertificateSigningRequest' + description: A list of certificate signing request objects. + 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' + CertificateGroupCertificateGetResp: + 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/Member' + 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' + DataEvictionPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + keep_size: + description: 'The maximum physical data space (in bytes) of a target + + file system before least recently read data is evicted. + + ' + type: integer + format: int64 + DataEvictionPolicy: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/PolicyBaseRenameable' + - type: object + properties: + keep_size: + description: 'The maximum physical data space(in bytes) of a target + + file system to have no non-expired data evicted. + + ' + type: integer + format: int64 + DataEvictionPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/DataEvictionPoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + DataEvictionPoliciesResponse: + type: object + properties: + items: + description: A list of Data Eviction policy objects. + type: array + items: + $ref: '#/components/schemas/DataEvictionPolicy' + DataEvictionPoliciesMembersGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/DataEvictionPoliciesMembersResponse' + - $ref: '#/components/schemas/_errorContextResponse' + DataEvictionPoliciesMembersResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/PolicyMemberContext' + description: A list of members for data eviction policies. + DirectoryService: + allOf: + - $ref: '#/components/schemas/_builtIn' + - 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: Obfuscated 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 + ca_certificate: + description: 'CA certificate used to validate the authenticity of the + configured + + servers. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + ca_certificate_group: + description: 'A certificate group containing CA certificates that can + be used to + + validate the authenticity of the configured servers. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + enabled: + description: Is the directory service enabled or not? + type: boolean + example: true + management: + $ref: '#/components/schemas/_directoryServiceManagement' + nfs: + $ref: '#/components/schemas/_directoryServiceNfs' + services: + description: 'Services that the directory service configuration is used + for. + + ' + type: array + readOnly: true + items: + type: string + description: 'Valid values include `nfs` and `management`. + + ' + example: management + example: + - management + smb: + $ref: '#/components/schemas/_directoryServiceSmb' + uris: + description: List of URIs for the configured directory servers. + type: array + maxItems: 30 + items: + pattern: ^(ldap|ldaps) + type: string + example: ldaps://ad1.mycompany.com + DirectoryServiceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/DirectoryServiceResponse' + DirectoryServiceResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/DirectoryService' + DirectoryServiceRolePost: + type: object + properties: + group: + description: 'Common Name (CN) of the directory service group containing + + users with authority level of the specified role name. + + ' + 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 directory + service role. + + ' + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + role: + description: 'Deprecated. + + `role` is deprecated in favor of `management_access_policies`, but remains + for + + backwards compatibility. If a directory service role has exactly one access + + policy, which corresponds to a valid legacy role of the same name, + + `role` will be a reference to that role. + + Otherwise, it will be `null`. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + DirectoryServiceRole: + type: object + properties: + group: + description: 'Common Name (CN) of the directory service group containing + + users with authority level of the specified role name. + + ' + 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 + id: + description: 'A non-modifiable, globally unique ID chosen by the system. + + ' + type: string + readOnly: true + management_access_policies: + description: 'List of management access policies associated with the directory + service role. + + ' + readOnly: true + type: array + items: + $ref: '#/components/schemas/_fixedReference' + name: + description: Name of the role mapping object. + type: string + readOnly: true + role: + description: 'Deprecated. + + `role` is deprecated in favor of `management_access_policies`, but remains + for + + backwards compatibility. If a directory service role has exactly one access + + policy, which corresponds to a valid legacy role of the same name, + + `role` will be a reference to that role. + + Otherwise, it will be `null`. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + DirectoryServiceRolesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/DirectoryServiceRolesResponse' + DirectoryServiceRolesResponse: + type: object + properties: + items: + description: A list of directory service role mapping configuration objects. + type: array + items: + $ref: '#/components/schemas/DirectoryServiceRole' + TestResultRemoteExecution: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/TestResultWithContext' + DnsPost: + type: object + properties: + domain: + description: 'Domain suffix to be appended by the appliance when performing + DNS lookups. + + ' + type: string + example: example.com + nameservers: + description: List of DNS server IP addresses. + type: array + maxItems: 3 + items: + type: string + example: '' + services: + description: 'The list of services utilizing the DNS configuration. + + ' + type: array + items: + type: string + description: 'Valid values include `management` and `data`. + + ' + sources: + description: 'The network interfaces used for communication with the DNS + server. + + The network interfaces must have the `services` value of `data` or `egress-only`. + + Clear this by setting an empty list. + + ' + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/_reference' + Dns: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/DnsPost' + - type: object + properties: + realms: + description: 'The realms containing this DNS. + + ' + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + DnsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/DnsResponse' + DnsResponse: + type: object + properties: + items: + description: A list of dns objects. + type: array + items: + $ref: '#/components/schemas/Dns' + DriveGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of drive objects. + type: array + items: + $ref: '#/components/schemas/Drive' + total: + type: object + allOf: + - $ref: '#/components/schemas/Drive' + - description: 'If `total_only` query param is `true`, then it 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 + FileSystemPost: + type: object + properties: + default_group_quota: + description: The default space quota for a group writing to this file system. + type: integer + format: int64 + default_user_quota: + description: The default space quota for a user writing to this file system. + type: integer + format: int64 + eradication_config: + $ref: '#/components/schemas/_fileSystemEradicationConfig' + fast_remove_directory_enabled: + description: 'If set to `true`, the file system, when mounted, will contain + a + + directory that can be used for fast removal of other directories. + + Directories can be moved into the fast remove directory in order + + to have them deleted, and their space freed, more quickly than a + + normal removal operation. + + If not specified, defaults to `false`. + + ' + type: boolean + group_ownership: + description: 'The group ownership for new files and directories in a file + system. + + Possible values are `creator` and `parent-directory`. + + If `creator` is selected, the owning group of new files and directories + + is the primary group of the user who creates them. + + If `parent-directory` is selected, the owning group is the parent + + directory group. + + Note: Existing files and directories are unaffected by this change. + + If not specified, defaults to `creator`. + + ' + type: string + hard_limit_enabled: + description: 'If set to `true`, the file system''s size, as defined by `provisioned`, + + is used as a hard limit quota. If not specified, defaults to `false`. + + ' + type: boolean + http: + description: HTTP configuration. + title: Http + allOf: + - $ref: '#/components/schemas/_http' + multi_protocol: + description: Multi-protocol configuration. + title: MultiProtocolPost + allOf: + - $ref: '#/components/schemas/_multiProtocolPost' + nfs: + description: NFS configuration. + title: Nfs + allOf: + - $ref: '#/components/schemas/_nfs' + node_group: + description: 'The node group''s nodes are where the file system''s files + are stored. + + Used only on hardware platforms supporting nodes. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + provisioned: + description: 'The provisioned size of the file system, displayed in bytes. + If set to an + + empty string (`""`), the file system is unlimited in size. + + If not specified, defaults to unlimited. + + ' + type: integer + format: int64 + qos_policy: + description: 'The QoS policy for the File System defines the performance + controls + + that can be applied to the aggregate performance of all the clients + + accessing the file system. + + If no policy is set here, no explicit performance controls are applied + + to the file system beyond the system''s default fairness. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + requested_promotion_state: + description: 'Possible values are `promoted` and `demoted`. + + The `demoted` state is used for replication targets and is only allowed + to be set + + if the file system is in a replica-link relationship. The additional + + query param `discard-non-snapshotted-data` must be set to `true` + + when demoting a file system. The default for new file systems is + + `promoted`. + + ' + type: string + readOnly: true + smb: + description: SMB configuration. + title: SmbPost + allOf: + - $ref: '#/components/schemas/_smbPost' + snapshot_directory_enabled: + description: 'If set to `true`, a hidden .snapshot directory will be present + in each + + directory of the file system when it is mounted. + + The .snapshot directory allows clients read access to the contents of + + the snapshots that have been taken of a directory. + + If set to `false`, the .snapshot directory will not be present in any + + directories within a mounted file system. If not specified, defaults to + `true`. + + ' + type: boolean + source: + description: 'The source snapshot whose data is copied to the file system + specified. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + workload: + $ref: '#/components/schemas/_workloadConfigurationReferencePost' + writable: + description: 'Whether the file system is writable or not. If `false`, this + overrides + + any protocol or file permission settings and prevents changes. If `true`, + then + + the protocol and file permission settings are evaluated. + + If not specified, defaults to `true`. Modifiable. + + ' + type: boolean + FileSystemPatch: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + created: + description: Creation timestamp of the file system. + type: integer + format: int64 + readOnly: true + default_group_quota: + description: The default space quota for a group writing to this file + system. + type: integer + format: int64 + default_user_quota: + description: The default space quota for a user writing to this file system. + type: integer + format: int64 + destroyed: + description: 'Returns a value of `true` if the file system has been destroyed + and is pending eradication. + + The file system cannot be modified while it is in the destroyed state. + + The `time_remaining` value displays the amount of time left until the + destroyed + + file system is permanently eradicated. Once eradication has begun, the + file system can no + + longer be recovered. Before the `time_remaining` period has elapsed, + + the destroyed file system can be recovered through the PATCH method + + by setting `destroyed=false`. + + ' + type: boolean + fast_remove_directory_enabled: + description: 'If set to `true`, the file system, when mounted, will contain + a + + directory that can be used for fast removal of other directories. + + Directories can be moved into the fast remove directory in order + + to have them deleted, and their space freed, more quickly than a + + normal removal operation. + + ' + type: boolean + group_ownership: + description: 'The group ownership for new files and directories in a file + system. + + Possible values are `creator` and `parent-directory`. + + If `creator` is selected, the owning group of new files and directories + + is the primary group of the user who creates them. + + If `parent-directory` is selected, the owning group is the parent + + directory group. + + Note: Existing files and directories are unaffected by this change. + + ' + type: string + hard_limit_enabled: + description: 'If set to `true`, the file system''s size, as defined by + `provisioned`, + + is used as a hard limit quota. + + ' + type: boolean + http: + description: HTTP configuration. + title: Http + allOf: + - $ref: '#/components/schemas/_http' + multi_protocol: + description: Multi-protocol configuration. + title: MultiProtocol + allOf: + - $ref: '#/components/schemas/_multiProtocol' + nfs: + description: NFS configuration. + title: NfsPatch + allOf: + - $ref: '#/components/schemas/_nfsPatch' + promotion_status: + description: 'Possible values are `promoted` and `demoted`. + + The current status of the file system with respect to replication. Changes + via + + `requested_promotion_state`. The default for new file systems is + + `promoted`. + + ' + type: string + readOnly: true + provisioned: + description: 'The provisioned size of the file system, displayed in bytes. + If set to an + + empty string (`""`), the file system is unlimited in size. + + ' + type: integer + format: int64 + example: 1048576 + qos_policy: + description: 'The QoS policy for the File System defines the performance + controls + + that can be applied to the aggregate performance of all the clients + + accessing the file system. + + If no policy is configured for a file system, then no performance + + controls are applied to it. + + Use "" to clear an attached policy. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + requested_promotion_state: + description: 'Possible values are `promoted` and `demoted`. + + The `demoted` state is used for replication targets and is only allowed + to be set + + if the file system is in a replica-link relationship. The additional + + query param `discard-non-snapshotted-data` must be set to `true` + + when demoting a file system. The default for new file systems is + + `promoted`. + + ' + type: string + smb: + description: SMB configuration. + title: Smb + allOf: + - $ref: '#/components/schemas/_smb' + snapshot_directory_enabled: + description: 'If set to `true`, a hidden .snapshot directory will be present + in each + + directory of the file system when it is mounted. + + The .snapshot directory allows clients read access to the contents of + + the snapshots that have been taken of a directory. + + If set to `false`, the .snapshot directory will not be present in any + + directories within a mounted file system. + + ' + type: boolean + source: + description: A reference to the source file system. + title: FixedLocationReference + allOf: + - $ref: '#/components/schemas/_fixedLocationReference' + storage_class: + $ref: '#/components/schemas/StorageClassInfo' + time_remaining: + description: 'Time in milliseconds before the file system is eradicated. + + `null` if not destroyed. + + ' + type: integer + format: int64 + readOnly: true + workload: + $ref: '#/components/schemas/_workloadConfigurationReferencePatch' + writable: + description: 'Whether the file system is writable or not. If `false`, + this overrides + + any protocol or file permission settings and prevents changes. If `true`, + then + + the protocol and file permission settings are evaluated. + + If not specified, defaults to `true`. Modifiable. + + ' + type: boolean + FileSystemGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemResponse' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + total: + $ref: '#/components/schemas/FileSystem' + FileSystemResponse: + type: object + properties: + items: + description: A list of file system objects. + type: array + items: + $ref: '#/components/schemas/FileSystem' + FileSystemGroupsPerformanceGetResponse: + type: object + properties: + items: + description: A list of file system group performance objects. + type: array + items: + $ref: '#/components/schemas/FileSystemGroupPerformance' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no items will be returned. + + ' + type: array + items: + $ref: '#/components/schemas/FileSystemGroupPerformance' + FileSystemPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of file system performance objects. + type: array + items: + $ref: '#/components/schemas/FileSystemPerformance' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no items will be returned. + + ' + type: array + items: + $ref: '#/components/schemas/FileSystemPerformance' + FileSystemUsersPerformanceGetResponse: + type: object + properties: + items: + description: A list of file system user performance objects. + type: array + items: + $ref: '#/components/schemas/FileSystemUserPerformance' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no items will be returned. + + ' + type: array + items: + $ref: '#/components/schemas/FileSystemUserPerformance' + WormDataPoliciesMembersGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/WormDataPoliciesMembersResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileSystemExportPost: + type: object + properties: + 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: Reference to the server the export will be visible on. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + share_policy: + description: Reference to the SMB share policy (only used for SMB). + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + FileSystemExportPatch: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_fileSystemExportBase' + FileSystemExportGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemExportResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileSystemExportResponse: + type: object + properties: + items: + description: A list of file system export objects. + type: array + items: + $ref: '#/components/schemas/FileSystemExport' + FileSystemReplicaLink: + allOf: + - $ref: '#/components/schemas/_replicaLinkBuiltIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + link_type: + description: 'Type of the replica link. + + Values include `full-replica`, and `partial-replica`. + + ' + type: string + local_file_system: + description: Reference to a local file system. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policies: + type: array + items: + description: Reference to a policy that is driving replication. + title: LocationReference + allOf: + - $ref: '#/components/schemas/_locationReference' + recovery_point: + description: 'Time when the last replicated snapshot was created, in milliseconds + + since UNIX epoch. I.e. the recovery point if the file system is promoted. + + ' + type: integer + format: int64 + readOnly: true + example: 1565034592494 + remote: + description: Reference to a remote array. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + remote_file_system: + description: Reference to a remote file system. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + status: + description: 'Status of the replica link. + + Values include `replicating`, `idle`, and `unhealthy`. + + ' + type: string + readOnly: true + FileSystemReplicaLinkGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemReplicaLinkResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileSystemReplicaLinkResponse: + type: object + properties: + items: + description: A list of file system replica link objects. + type: array + items: + $ref: '#/components/schemas/FileSystemReplicaLink' + PolicyMemberWithRemoteGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyMemberWithRemoteResponse' + - $ref: '#/components/schemas/_errorContextResponse' + PolicyMemberWithRemoteResponse: + allOf: + - $ref: '#/components/schemas/_context' + - type: object + properties: + items: + description: A list of members for policies. + type: array + items: + $ref: '#/components/schemas/PolicyMemberWithRemote' + FileSystemSnapshotGetTransferResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemSnapshotTransferResponse' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + total: + description: 'If `total_only` query param is `true`, then it 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. + + ' + title: FileSystemSnapshotTransfer + allOf: + - $ref: '#/components/schemas/FileSystemSnapshotTransfer' + FileSystemSnapshotPost: + type: object + properties: + suffix: + description: The suffix of the snapshot, e.g., `snap1`. + type: string + FileSystemSnapshot: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/_context' + - type: object + properties: + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + destroyed: + description: 'Is the file system snapshot destroyed? If not specified, + defaults to + + `false`. + + ' + type: boolean + owner: + description: 'A reference to the file system that owns this snapshot. + + If the owner is destroyed, this will be destroyed. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + owner_destroyed: + description: Is the owning file system destroyed? + type: boolean + readOnly: true + policies: + description: An array of references to the associated policies. + readOnly: true + type: array + items: + $ref: '#/components/schemas/_fixedLocationReference' + policy: + description: 'A reference to the associated policy that drives the behavior + of the + + snapshot. + + ' + title: FixedLocationReference + allOf: + - $ref: '#/components/schemas/_fixedLocationReference' + source: + description: 'A reference to the file system that was the source of the + data in + + this snapshot. Normally this is the same as the owner, but if + + the snapshot is replicated, the source is the original file system. + + ' + title: FixedLocationReference + allOf: + - $ref: '#/components/schemas/_fixedLocationReference' + suffix: + description: The suffix of the snapshot, e.g., `snap1`. + type: string + readOnly: true + example: snap1 + time_remaining: + description: 'Time in milliseconds before the file system snapshot is + eradicated. + + `null` if not destroyed. + + ' + type: integer + format: int64 + readOnly: true + FileSystemSnapshotGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemSnapshotResponse' + - $ref: '#/components/schemas/_errorContextResponse' + - type: object + properties: + total: + description: 'If `total_only` query param is `true`, then it 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. + + ' + title: FileSystemSnapshot + allOf: + - $ref: '#/components/schemas/FileSystemSnapshot' + FileSystemSnapshotResponse: + type: object + properties: + items: + description: A list of file system snapshot objects. + type: array + items: + $ref: '#/components/schemas/FileSystemSnapshot' + PolicyFileSystemSnapshotGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyFileSystemSnapshotResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileLockGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileLockResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileSystemClientsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemClientsResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileLockNlmReclamationResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/FileSystemLockNlmReclamation' + FileSessionGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSessionResponse' + - $ref: '#/components/schemas/_errorContextResponse' + FileSystemSpaceStorageClassGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of file system storage class space objects. + type: array + items: + $ref: '#/components/schemas/FileSystemStorageClassSpace' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no items will be returned. + + ' + type: array + items: + $ref: '#/components/schemas/FileSystemStorageClassSpace' + FileSystemOpenFilesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/FileSystemOpenFilesResponse' + 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' + Hardware: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + data_mac: + description: 'Ethernet (data) MAC address + + ' + type: string + readOnly: true + example: fa:16:3e:a1:c6:ce + details: + description: 'Details about the status of the component if not healthy. + + ' + type: string + readOnly: true + example: Temperature too high + 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 + readOnly: true + example: 1 + management_mac: + description: 'Hardware component (burned-in) MAC address + + ' + type: string + readOnly: true + example: 24:a9:37:ca:a0:d0 + model: + description: Model number of the hardware component. + type: string + readOnly: true + example: FB-8TB + part_number: + description: 'Part number of the hardware component. + + ' + type: string + readOnly: true + example: 83-0139-01 + sensor_readings: + type: array + readOnly: true + items: + $ref: '#/components/schemas/HardwareTemperatures' + serial: + description: Serial number of the hardware component. + type: string + readOnly: true + example: S16445515B09553 + slot: + description: 'Slot number occupied by the PCI Express card that hosts + the component. + + ' + type: integer + format: int32 + readOnly: true + example: 16 + speed: + description: The maximum speed (in b/s) at which the component is capable + of operating. + type: integer + format: int64 + readOnly: true + example: 10000000000 + status: + description: 'Component status. + + Valid values are `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: 'Type of hardware component. + + Valid values are `bay`, `ch`, `eth`, `fan`, `fb`, `fm`, `pwr`, and `xfm`. + + ' + type: string + readOnly: true + example: ch + HardwareGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/HardwareResponse' + HardwareResponse: + type: object + properties: + items: + description: A list of hardware component objects. + type: array + items: + $ref: '#/components/schemas/Hardware' + HardwareConnector: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + connector_type: + description: 'Form-factor of the interface. + + Valid values include QSFP, QSFP+, QSFP28, QSFP56, QSFP-DD, RJ-45, and + -. + + ' + type: string + readOnly: true + example: QSFP + lane_speed: + description: 'Configured speed of each lane in the connector in bits-per-second. + + ' + type: integer + format: int64 + example: 10000000000 + lanes_per_port: + description: Configured number of lanes comprising each port in the connector. + type: integer + format: int64 + example: 4 + port_count: + description: 'Configured number of ports in the connector (1/2/4 for QSFP). + + ' + type: integer + format: int64 + example: 1 + port_speed: + description: Configured speed of each port in the connector in bits-per-second. + type: integer + format: int64 + example: 40000000000 + transceiver_type: + description: 'Details about the transceiver which is plugged into the + connector port. + + Transceiver type will be read-only for pureuser. If nothing is plugged + + into QSFP port, value will be `Unused` and type cannot be auto-detected, + + and internal user has not specified a type - value will be `Unknown`. + + If transceiver is plugged in, and type is auto-detected, and/or type + + has been explicitly set by internal user - that value will be shown. + + Transceiver type is not applicable for RJ-45 connectors. + + ' + type: string + readOnly: true + example: 40GBASE-LR4 + HardwareConnectorGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/HardwareConnectorResponse' + HardwareConnectorResponse: + type: object + properties: + items: + description: A list of connector objects. + type: array + items: + $ref: '#/components/schemas/HardwareConnector' + HardwareConnectorPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of hardware connector performance objects. + type: array + items: + $ref: '#/components/schemas/HardwareConnectorPerformance' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no individual items will + be returned. + + ' + type: array + items: + $ref: '#/components/schemas/HardwareConnectorPerformance' + KeytabPost: + type: object + properties: + source: + description: 'A reference to the Active Directory configuration for the + computer account + + whose keys will be rotated in order to create new keytabs for all of its + + registered service principal names. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + KeytabGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/KeytabResponse' + KeytabResponse: + type: object + properties: + items: + description: A list of Kerberos keytab objects. + type: array + items: + $ref: '#/components/schemas/Keytab' + KeytabFileResponse: + description: A Kerberos keytab file. + type: string + format: binary + Keytab_file: + description: 'The keytab file to upload. + + ' + type: string + KmipServer: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + ca_certificate: + description: 'CA certificate used to validate the authenticity of the + configured servers. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + ca_certificate_group: + description: 'A certificate group containing CA certificates that can + be used to + + validate the authenticity of the configured servers. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + uris: + description: List of URIs for the configured KMIP servers in the format + [protocol://]hostname:port. + type: array + minItems: 1 + maxItems: 30 + items: + pattern: ^(tls://)? + type: string + example: + - my1.kmipserver.com:5696 + - tls://my2.kmipserver.com:5696 + KmipServerResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/KmipServer' + LegalHold: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + description: + description: 'The description of the legal hold instance. + + ' + type: string + realms: + description: 'The realms containing this legal hold. + + ' + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + LegalHoldsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LegalHoldsResponse' + LegalHoldsResponse: + type: object + properties: + items: + description: A list of legal hold instances. + type: array + items: + $ref: '#/components/schemas/LegalHold' + LegalHoldsHeldEntitiesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LegalHoldsHeldEntitiesResponse' + LegalHoldsHeldEntitiesResponse: + type: object + properties: + items: + description: A list of held entities for legal holds. + type: array + items: + $ref: '#/components/schemas/LegalHoldHeldEntity' + LifecycleRulePost: + allOf: + - $ref: '#/components/schemas/_lifecycleRuleConfigExtension' + - type: object + properties: + bucket: + description: The bucket name for lifecycle rule creation. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + keep_previous_version_for: + description: 'Time after which previous 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 + prefix: + description: 'Object key prefix identifying one or more objects in the + bucket. + + Can have a maximum length of 1024 characters. + + ' + type: string + rule_id: + description: 'Identifier for the rule that is unique to the bucket + + that it applies to. + + Can have a maximum length of 255 characters. + + If not specified, an id unique to the bucket will be generated in the + + format `fbRuleId` where number increments, starting at 1. + + ' + type: string + LifecycleRulePatch: + allOf: + - $ref: '#/components/schemas/_lifecycleRuleConfigExtension' + - type: object + properties: + enabled: + description: 'If set to `true`, this rule will be enabled. + + ' + type: boolean + keep_previous_version_for: + description: 'Time after which previous 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 + prefix: + description: 'Object key prefix identifying one or more objects in the + bucket. + + Can have a maximum length of 1024 characters. + + ' + type: string + LifecycleRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/LifecycleRuleResponse' + LifecycleRuleResponse: + type: object + properties: + items: + description: A list of lifecycle rule objects. + type: array + items: + $ref: '#/components/schemas/LifecycleRule' + LinkAggregationGroup: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: 'Configuration information for a combination of physical ports + grouped + + together into an aggregated-port. + + ' + type: object + properties: + lag_speed: + description: 'Combined speed of all ports in the LAG in bits-per-second. + + ' + type: integer + format: int64 + readOnly: true + example: 260000000000 + mac_address: + description: Unique MAC address assigned to the LAG. + type: string + pattern: ^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$ + readOnly: true + example: 24:a9:37:11:f5:21 + port_speed: + description: Configured speed of each port in the LAG in bits-per-second. + type: integer + format: int64 + readOnly: true + example: 10000000000 + ports: + description: Ports associated with the LAG. + type: array + items: + $ref: '#/components/schemas/_reference' + status: + description: 'Health status of the LAG. + + Valid values are `critical`, `healthy`, `identifying`, `unclaimed`, + + `unhealthy`, `unrecognized`, and `unused`. + + ' + type: string + readOnly: true + example: healthy + LinkAggregationGroupPatch: + type: object + properties: + add_ports: + type: array + items: + $ref: '#/components/schemas/_reference' + ports: + type: array + items: + $ref: '#/components/schemas/_reference' + remove_ports: + type: array + items: + $ref: '#/components/schemas/_reference' + LinkAggregationGroupGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LinkAggregationGroupResponse' + LinkAggregationGroupResponse: + type: object + properties: + items: + description: A list of lag objects. + type: array + items: + $ref: '#/components/schemas/LinkAggregationGroup' + LogsAsync: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + available_files: + description: 'All of the available files ready for download. + + ' + type: array + readOnly: true + items: + $ref: '#/components/schemas/FileInfo' + end_time: + description: 'When the time window ends (in milliseconds since epoch). + + start_time and end_time determine the number of hours for which the + logs are prepared for. + + At most 6 hours of logs can be prepared in one request. + + start_time and end_time are truncated to hour boundaries. + + ' + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + hardware_components: + description: 'All of the hardware components for which logs are being + processed. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + last_request_time: + description: 'The last time log preparation was requested (in milliseconds + since epoch). + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + example: 1514764800000 + processing: + description: 'Returns a value of `true` if the logs are being prepared. + + ' + type: boolean + readOnly: true + progress: + description: 'A representation of log preparation progress. Ranges from + 0 to 1.0. + + ' + type: number + format: float + readOnly: true + example: 0.99 + start_time: + description: 'When the time window starts (in milliseconds since epoch). + + start_time and end_time determine the number of hours for which the + logs are prepared for. + + At most 6 hours of logs can be prepared in one request. + + start_time and end_time are truncated to hour boundaries. + + ' + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + LogsAsyncGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LogsAsyncResponse' + LogsAsyncResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/LogsAsync' + LogTargetsFileSystemsPost: + allOf: + - $ref: '#/components/schemas/LogTargetsFileSystems' + LogTargetsFileSystems: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + file_system: + description: The target filesystem where audit logs will be stored. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + keep_for: + description: 'Specifies the period that audit logs are retained before + they are deleted, + + in milliseconds. + + Default value is `null` which means time 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`. + + At least one of the `keep_for` or `keep_size` parameters is required, + + and they can be set together. + + ' + type: integer + format: int64 + minimum: 1000000 + example: 1000000 + LogTargetsFileSystemsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LogTargetsFileSystemsResponse' + LogTargetsFileSystemsResponse: + type: object + properties: + items: + description: A list of log target objects. + type: array + items: + $ref: '#/components/schemas/LogTargetsFileSystems' + LogTargetsObjectStorePost: + allOf: + - $ref: '#/components/schemas/LogTargetsObjectStore' + LogTargetsObjectStore: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + bucket: + description: 'Reference to the bucket where audit logs will be stored. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + log_name_prefix: + description: 'The prefix of the audit log object. + + ' + title: AuditLogNamePrefix + allOf: + - $ref: '#/components/schemas/_auditLogNamePrefix' + log_rotate: + description: 'The threshold after which the audit log object will be rotated. + + ' + title: AuditLogRotate + allOf: + - $ref: '#/components/schemas/_auditLogRotate' + LogTargetsObjectStoreGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/LogTargetsObjectStoreResponse' + - $ref: '#/components/schemas/_errorContextResponse' + LogTargetsObjectStoreResponse: + type: object + properties: + items: + description: A list of log target objects. + type: array + items: + $ref: '#/components/schemas/LogTargetsObjectStoreWithContext' + MaintenanceWindowPost: + type: object + properties: + timeout: + description: 'Duration of a maintenance window measured in milliseconds. + + The `names` and `timeout` parameters must be set together, and the `names` + parameter + + must be set to `array`. + + ' + type: integer + format: int32 + example: 14400000 + MaintenanceWindowsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/MaintenanceWindowsResponse' + MaintenanceWindowsResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/MaintenanceWindow' + ManagementAccessPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - 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. + + If not specified, defaults to `all-permissions`. + + ' + type: string + rules: + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/ManagementAccessPolicyRuleInPolicy' + description: 'All of the rules that are part of this policy. The order + is the evaluation order. + + ' + ManagementAccessPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - 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. + + If not specified, defaults to `all-permissions`. + + ' + type: string + rules: + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/ManagementAccessPolicyRuleInPolicy' + description: 'All of the rules that are part of this policy. The order + is the evaluation order. + + ' + ManagementAccessPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ManagementAccessPoliciesResponse' + ManagementAccessPoliciesResponse: + type: object + properties: + items: + description: A list of management access policy configuration objects. + type: array + items: + $ref: '#/components/schemas/ManagementAccessPolicy' + ManagementAuthenticationPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + ssh: + description: 'The management authentication config for SSH logins. This + controls what authentication + + factors admins need to present when logging in via SSH. + + ' + title: ManagementAuthenticationPolicyConfig + allOf: + - $ref: '#/components/schemas/ManagementAuthenticationPolicyConfig' + ManagementAuthenticationPolicy: + allOf: + - $ref: '#/components/schemas/ManagementAuthenticationPolicyPost' + - $ref: '#/components/schemas/PolicyBaseContext' + ManagementAuthenticationPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ManagementAuthenticationPoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + ManagementAuthenticationPoliciesResponse: + type: object + properties: + items: + description: A list of management authentication policy objects. + type: array + items: + $ref: '#/components/schemas/ManagementAuthenticationPolicy' + NetworkAccessPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - type: object + properties: + rules: + description: 'All of the rules that are part of this policy. The order + is the + + evaluation order. + + If a client does not match any rule in the policy for the interface + that + + they are attempting to access, the default is to deny access. + + ' + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/NetworkAccessPolicyRuleInPolicy' + NetworkAccessPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkAccessPolicyResponse' + NetworkAccessPolicyResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/NetworkAccessPolicy' + NetworkAccessPolicyRulePost: + allOf: + - $ref: '#/components/schemas/NetworkAccessPolicyRulePostBase' + - $ref: '#/components/schemas/_policyRuleIndex' + NetworkAccessPolicyRule: + allOf: + - $ref: '#/components/schemas/NetworkAccessPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndex' + NetworkAccessPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkAccessPolicyRuleResponse' + NetworkAccessPolicyRuleResponse: + type: object + properties: + items: + description: 'Displays a list of all items after filtering. + + ' + type: array + items: + $ref: '#/components/schemas/NetworkAccessPolicyRule' + NetworkInterface: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + address: + description: 'The IPv4 or IPv6 address to be associated with the specified + network + + interface. + + ' + type: string + attached_servers: + description: 'List of servers that are using this interface for data ingress. + + When services include ''data'' defaults to [_array_server], otherwise + to []. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + enabled: + description: 'Indicates if the specified network interface is enabled + (`true`) or + + disabled (`false`). If not specified, defaults to `true`. + + ' + type: boolean + readOnly: true + gateway: + description: Derived from `subnet.gateway`. + type: string + readOnly: true + mtu: + description: Derived from `subnet.mtu`. + type: integer + format: int32 + readOnly: true + netmask: + description: Derived from `subnet.prefix`. + type: string + readOnly: true + realms: + description: 'The realms containing this network interface. + + ' + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + services: + description: Services and protocols that are enabled on the interface. + type: array + items: + type: string + description: 'Valid values are `data`, `egress-only`, `management`, + `replication`, and `support`. + + ' + subnet: + type: object + allOf: + - $ref: '#/components/schemas/_fixedReference' + - type: object + readOnly: true + type: + description: 'The only valid value is `vip`. + + ' + type: string + vlan: + description: Derived from `subnet.vlan`. + type: integer + format: int32 + readOnly: true + NetworkInterfacePatch: + type: object + properties: + address: + description: 'The IPv4 or IPv6 address to be associated with the specified + network + + interface. + + ' + type: string + attached_servers: + description: '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. + + If services include ''data'' and attached_servers was [] then attached_servers + defaults to [_array_server]. + + ' + type: array + items: + $ref: '#/components/schemas/_referenceWithoutType' + services: + description: Services and protocols that are enabled on the interface. + type: array + items: + type: string + description: 'Valid values are `data`, `egress-only`, `management`, `replication`, + and `support`. + + ' + NetworkInterfaceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkInterfaceResponse' + NetworkInterfaceResponse: + type: object + properties: + items: + description: A list of network interface objects. + type: array + items: + $ref: '#/components/schemas/NetworkInterface' + NetworkInterfacePingGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkInterfacePingResponse' + NetworkInterfaceTraceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkInterfaceTraceResponse' + NetworkInterfacesConnectorsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkInterfacesConnectorsResponse' + NetworkInterfacesConnectorsResponse: + type: object + properties: + items: + description: A list of network connector objects. + type: array + items: + $ref: '#/components/schemas/HardwareConnector' + NetworkInterfacesConnectorsPerformanceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of network connector performance objects. + type: array + items: + $ref: '#/components/schemas/NetworkInterfacesConnectorsPerformance' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no individual items will + be returned. + + ' + type: array + items: + $ref: '#/components/schemas/NetworkInterfacesConnectorsPerformance' + NetworkInterfacesConnectorsSettingsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of global network settings for network connectors. + type: array + items: + $ref: '#/components/schemas/NetworkInterfacesConnectorsSetting' + NetworkConnectionStatisticsGetResponse: + allOf: + - $ref: '#/components/schemas/NetworkConnectionStatisticsResponse' + NetworkInterfaceNeighborGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NetworkInterfaceNeighborResponse' + NfsExportPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + rules: + description: 'All of the rules that are part of this policy. The order + is the evaluation order. + + ' + type: array + items: + $ref: '#/components/schemas/NfsExportPolicyRuleInPolicy' + NfsExportPolicyPatch: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - type: object + properties: + rules: + description: 'All of the rules that are part of this policy. The order + is the evaluation order. + + ' + type: array + items: + $ref: '#/components/schemas/NfsExportPolicyPatchRuleInPolicy' + NfsExportPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NfsExportPolicyResponse' + - $ref: '#/components/schemas/_errorContextResponse' + NfsExportPolicyResponse: + type: object + properties: + items: + description: A list of NFS export policy objects. + type: array + items: + $ref: '#/components/schemas/NfsExportPolicy' + NfsExportPolicyRule: + allOf: + - $ref: '#/components/schemas/NfsExportPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndex' + - $ref: '#/components/schemas/_context' + NfsExportPolicyRulePatch: + allOf: + - $ref: '#/components/schemas/NfsExportPolicyRuleBasePatchRequest' + - $ref: '#/components/schemas/_policyRuleIndex' + NfsExportPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NfsExportPolicyRuleResponse' + - $ref: '#/components/schemas/_errorContextResponse' + NfsExportPolicyRuleResponse: + type: object + properties: + items: + description: 'Displays a list of all items after filtering. + + ' + type: array + items: + $ref: '#/components/schemas/NfsExportPolicyRule' + Node: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + capacity: + description: 'The available capacity of the node in bytes. + + ' + type: integer + format: int64 + readOnly: true + chassis_serial_number: + description: 'The serial number of the chassis the node is in, if applicable. + + ' + type: string + readOnly: true + data_addresses: + description: 'List of data IP addresses of the node. + + ' + type: array + readOnly: true + items: + type: string + details: + description: 'The description of the status of the node if not healthy. + + ' + type: string + readOnly: true + management_address: + description: 'The control IP address of the node. A connection will be + made + + to this address to get info on the node such as the data addresses. + + If a connection cannot be made to the given management address, + + both the POST and PATCH request modifying this field will fail. + + ' + type: string + raw_capacity: + description: 'The raw capacity of the node in bytes. + + ' + type: integer + format: int64 + readOnly: true + serial_number: + description: 'The serial number of the node. + + If the given serial number does not match the serial number of the node, + + both the POST and PATCH request modifying this field will fail. + + ' + type: string + status: + description: 'The status of the node. + + Values include `critical`, `healthy`, and `unhealthy`. + + ' + type: string + readOnly: true + unique: + description: 'The unique physical space occupied by customer data in bytes. + + ' + type: integer + format: int64 + readOnly: true + NodeGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NodeResponse' + - type: object + properties: + total: + $ref: '#/components/schemas/Node' + NodeResponse: + type: object + properties: + items: + description: A list of node objects. + type: array + items: + $ref: '#/components/schemas/Node' + NodeGroupPatch: + allOf: + - $ref: '#/components/schemas/_referenceNameOnly' + NodeGroupGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NodeGroupResponse' + NodeGroupResponse: + type: object + properties: + items: + description: A list of node group objects. + type: array + items: + $ref: '#/components/schemas/NodeGroup' + NodeGroupNodeGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/NodeGroupNodeResponse' + NodeGroupNodeResponse: + type: object + properties: + items: + description: 'A list of node and node group relationships. + + ' + type: array + items: + $ref: '#/components/schemas/Member' + NodeGroupUseGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of node group use objects. + type: array + items: + $ref: '#/components/schemas/NodeGroupUse' + ObjectStoreAccessKeyPost: + type: object + properties: + secret_access_key: + description: 'The secret access key to import from another FlashBlade. + + To import a set of credentials, this field must be specified + + with the `names` query parameter where the `names` includes + + prefix of the realm where the user lives. If both of these are not + + specified, the system will generate a new set of credentials. + + ' + type: string + user: + type: object + allOf: + - $ref: '#/components/schemas/_reference' + - description: Reference of the associated user. + type: object + ObjectStoreAccessKey: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + access_key_id: + description: 'The access key ID which can be used directly to + + authorize S3 operations. + + ' + type: string + readOnly: true + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + enabled: + description: 'Is the access key enabled? If not specified, defaults to + `false`. + + ' + type: boolean + secret_access_key: + description: 'The secret access key, only populated on creation if it + is not + + imported from another FlashBlade. + + ' + type: string + readOnly: true + user: + description: Reference of the associated user. + readOnly: true + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + 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' + ObjectStoreAccessPolicyPost: + allOf: + - $ref: '#/components/schemas/ObjectStoreAccessPolicyPatch' + - type: object + properties: + description: + description: 'A description of the policy, optionally specified when the + policy is + + created. Cannot be modified for an existing policy. + + ' + type: string + ObjectStoreAccessPolicyPatch: + type: object + properties: + rules: + type: array + items: + $ref: '#/components/schemas/PolicyRuleObjectAccessBulkManage' + ObjectStoreAccessPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreAccessPolicyResponse' + ObjectStoreAccessPolicyResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ObjectStoreAccessPolicy' + PolicyRuleObjectAccessPost: + type: object + properties: + actions: + description: 'The list of actions granted by this rule. Each included action + may + + restrict other properties of the rule. + + Supported actions are returned by the + + `/object-store-access-policy-actions` endpoint. + + ' + type: array + items: + type: string + example: + - s3:CreateBucket + - s3:PutObject + conditions: + description: 'Conditions used to limit the scope which this rule applies + to. + + ' + title: PolicyRuleObjectAccessCondition + allOf: + - $ref: '#/components/schemas/_policyRuleObjectAccessCondition' + 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 + example: allow + 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* + ObjectStoreAccessPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreAccessPolicyRuleResponse' + ObjectStoreAccessPolicyRuleResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/PolicyRuleObjectAccess' + ObjectStoreAccessPolicyActionGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreAccessPolicyActionResponse' + ObjectStoreAccountPost: + type: object + properties: + account_exports: + description: 'A list of exports to be created for the account. + + + If ommited or set to `null`, the default server for object store will + be used. + + Use `[]` to create an account without any export. + + ' + type: array + items: + title: ServerForAccountExport + allOf: + - $ref: '#/components/schemas/_serverForAccountExport' + bucket_defaults: + description: 'Default settings to be applied to newly created buckets associated + with + + this account. Values here will be used in bucket creation requests which + + do not specify their own values for corresponding fields. + + ' + title: BucketDefaults + allOf: + - $ref: '#/components/schemas/_bucketDefaults' + hard_limit_enabled: + description: 'If set to `true`, the account''s size, as defined by `quota_limit`, + + is used as a hard limit quota. + + If set to `false`, a hard limit quota will not be applied to the + + account, but soft quota alerts will still be sent if the account has + + a value set for `quota_limit`. + + If not specified, defaults to `false`. + + ' + type: boolean + quota_limit: + description: 'The effective quota limit to be applied against the size of + the account, displayed in bytes. + + If set to an empty string (`""`), the account is unlimited in size. If + not specified, + + defaults to unlimited. + + ' + type: string + ObjectStoreAccountPatch: + type: object + properties: + bucket_defaults: + description: 'Default settings to be applied to newly created buckets associated + with + + this account. Values here will be used in bucket creation requests which + + do not specify their own values for corresponding fields. + + ' + title: BucketDefaults + allOf: + - $ref: '#/components/schemas/_bucketDefaults' + hard_limit_enabled: + description: 'If set to `true`, the account''s size, as defined by `quota_limit`, + + is used as a hard limit quota. + + If set to `false`, a hard limit quota will not be applied to the + + account, but soft quota alerts will still be sent if the account has + + a value set for `quota_limit`. + + ' + type: boolean + public_access_config: + $ref: '#/components/schemas/_publicAccessConfig' + quota_limit: + description: 'The effective quota limit to be applied against the size of + the account, displayed in bytes. + + If set to an empty string (`""`), the account is unlimited in size. + + ' + type: string + 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. + + ' + title: ObjectStoreAccount + allOf: + - $ref: '#/components/schemas/ObjectStoreAccount' + ObjectStoreAccountResponse: + type: object + properties: + items: + description: A list of object store account objects. + type: array + items: + $ref: '#/components/schemas/ObjectStoreAccount' + ObjectStoreAccountExportPost: + type: object + required: + - server + properties: + export_enabled: + description: 'If set to `true`, the account export is enabled. + + If not specified, defaults to `true`. + + ' + type: boolean + example: true + server: + description: Reference to the server the export will be visible on. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + ObjectStoreAccountExportPatch: + type: object + properties: + export_enabled: + description: 'If set to `true`, the account export is enabled. + + If not specified, defaults to `true`. + + ' + type: boolean + example: true + policy: + description: Reference to the s3 export policy that is used for the export. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + ObjectStoreAccountExportGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ObjectStoreAccountExportResponse' + - $ref: '#/components/schemas/_errorContextResponse' + ObjectStoreAccountExportResponse: + type: object + properties: + items: + description: A list of object store account export objects. + type: array + items: + $ref: '#/components/schemas/ObjectStoreAccountExport' + ObjectStoreRemoteCredentialsPost: + type: object + properties: + access_key_id: + description: 'Access Key ID to be used when connecting to a remote object + store. + + ' + type: string + example: PSFBIKZFCAAAKOEJ + secret_access_key: + description: 'Secret Access Key to be used when connecting to a remote object + store. + + ' + type: string + example: 0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD + ObjectStoreRemoteCredentials: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/_context' + - type: object + properties: + access_key_id: + description: 'Access Key ID to be used when connecting to a remote object + store. + + ' + type: string + example: PSFBIKZFCAAAKOEJ + realms: + description: 'The realms containing this credentials for remote. + + ' + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + remote: + description: 'Reference to the associated remote, which can either be + a `target` or remote `array`. + + If it is an `array`, then the `resource-type` field will not be populated. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + secret_access_key: + description: 'Secret Access Key to be used when connecting to a remote + object store. + + ' + type: string + example: 0BEC00003+b1228C223c0FbF1ab5e4GICJGBPJPEOLJCD + ObjectStoreRemoteCredentialGetResp: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreRemoteCredentialsResp' + ObjectStoreRemoteCredentialsResp: + type: object + properties: + items: + description: A list of object store remote credentials. + type: array + items: + $ref: '#/components/schemas/ObjectStoreRemoteCredentials' + ObjectStoreRolePost: + type: object + properties: + max_session_duration: + description: 'Maximum session duration in milliseconds. + + If not provided when creating the role, defaults to 1h, minimum is 1h, + maximum is 12h. + + ' + type: integer + ObjectStoreRole: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + account: + description: Reference of the associated account. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + max_session_duration: + description: 'The maximum session duration for the role in milliseconds + + ' + type: integer + prn: + description: Pure Resource Name of the role + type: string + readOnly: true + example: prn::iam:array-id/local:obj-account-id/123456789101112:role/myrole + trusted_entities: + description: List of trusted entities + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + ObjectStoreRoleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreRoleResponse' + ObjectStoreRoleResponse: + type: object + properties: + items: + description: A list of object store roles. + type: array + items: + $ref: '#/components/schemas/ObjectStoreRole' + ObjectStoreTrustPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreTrustPolicyResponse' + ObjectStoreTrustPolicyIam: + description: Trust policy document in the AWS IAM format. + type: string + example: "{\n \"Version\": \"2012-10-17\",\n \"Statement\": [{\n \"Action\": + \"sts:AssumeRoleWithSAML\",\n \"Effect\": \"Allow\",\n \"Principal\": + {\n \"Federated\": \"arn:aws:iam:::saml-provider/example\"\n },\n + \ \"Condition\": {\n \"StringEquals\": {\n \"saml:aud\": \"engineers\"\n + \ }\n }\n }]\n}" + ObjectStoreTrustPolicyResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ObjectStoreTrustPolicy' + TrustPolicyRulePost: + type: object + properties: + actions: + description: 'The list of role-assumption actions granted by this rule to + the respective role. + + Currently we support `sts:AssumeRoleWithSAML` and `sts:AssumeRoleWithWebIdentity` + actions. + + ' + type: array + items: + type: string + example: + - sts:AssumeRoleWithSAML + conditions: + description: 'Conditions used to limit the scope which this rule applies + to. + + ' + type: array + items: + $ref: '#/components/schemas/_trustPolicyRuleCondition' + 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. + + Valid values include `allow`. + + ' + type: string + readOnly: true + example: allow + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + principals: + description: List of Identity Providers + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + ObjectStoreTrustPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/_errorContextResponse' + - $ref: '#/components/schemas/ObjectStoreTrustPolicyRuleResponse' + ObjectStoreTrustPolicyRuleResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/TrustPolicyRuleWithContext' + 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' + ObjectStoreVirtualHost: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + description: 'Hostname configuration for virtual hosted-style S3 requests. + + ' + properties: + attached_servers: + description: 'A list of servers which are allowed to use this virtual + host. + + If it is `null` or not specified and a default object store + + server is configured, it will be automatically attached. If + + set to `[]`, no servers are attached. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + hostname: + description: 'A hostname by which the array can be addressed for + + virtual hosted-style S3 requests. A hostname cannot + + exceed 255 characters in length, it cannot be an IP + + address, and supersets or subsets of existing hostnames + + with the same root are not allowed. + + ' + type: string + example: s3.myarray.com + realms: + description: 'A list of realms containing this virtual host. + + ' + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + ObjectStoreVirtualHostPatch: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + add_attached_servers: + description: 'A list of new servers which are allowed to use this virtual + host. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + attached_servers: + description: 'A list of servers which are allowed to use this virtual + host. + + If it is `null` or not specified and a default object store + + server is configured, it will be automatically attached. If + + set to `[]`, no servers are attached. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + hostname: + description: 'A hostname by which the array can be addressed for + + virtual hosted-style S3 requests. A hostname cannot + + exceed 255 characters in length, it cannot be an IP + + address, and supersets or subsets of existing hostnames + + with the same root are not allowed. + + ' + type: string + example: s3.myarray.com + remove_attached_servers: + description: 'A list of servers which will no longer be allowed to use + this virtual host. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + 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' + PasswordPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - type: object + properties: + enforce_dictionary_check: + description: 'If `true`, test password against dictionary of known leaked + passwords. + + Requires passwords longer than 6 characters. + + ' + type: boolean + example: true + enforce_username_check: + description: 'If `true`, the username cannot be a substring of the password. + + Only applies to usernames of 4 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: 0 + 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: 0 + 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 1 hour precision. + + 0ms value means password expiration is disabled. + + Maximum age is always greater than the minimum password age. + + ' + 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. + + ' + type: integer + format: int32 + minimum: 0 + 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 with precision to 1 hour. + + ' + 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: 0 + 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 + PasswordPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PasswordPoliciesResponse' + PasswordPoliciesResponse: + 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/PasswordPolicy' + PolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + retention_lock: + description: 'If retention lock is locked, then the the policy can not + be removed + + from the associated file systems and the rules may not be changed. + + Valid values are `locked` and `unlocked`. + + Contact Pure Technical Services to change `locked` to `unlocked`. + + ' + type: string + readOnly: true + rules: + type: array + items: + $ref: '#/components/schemas/_policy_rule' + SnapshotPolicyPatch: + allOf: + - $ref: '#/components/schemas/SnapshotWormDataPolicyBase' + - type: object + properties: + add_rules: + type: array + items: + $ref: '#/components/schemas/_policy_rule' + remove_rules: + type: array + items: + $ref: '#/components/schemas/_policy_rule' + retention_lock: + description: 'If retention lock is locked, then the the policy can not + be removed + + from the associated file systems and the rules may not be changed. + + Valid values are `locked` and `unlocked`. + + Contact Pure Technical Services to change `locked` to `unlocked`. + + ' + type: string + readOnly: true + rules: + type: array + items: + $ref: '#/components/schemas/_policy_rule' + PolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyResponse' + - $ref: '#/components/schemas/_errorContextResponse' + PolicyResponse: + type: object + properties: + items: + description: A list of policy objects. + type: array + items: + $ref: '#/components/schemas/Policy' + PolicyBaseGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PolicyBaseResponse' + - $ref: '#/components/schemas/_errorContextResponse' + PublicKeyPost: + description: 'A public key configuration, defining a key used for cryptographic + signature verification. + + ' + type: object + properties: + public_key: + description: 'The text of the public key. May be PEM-formatted or OpenSSH-formatted + at the time of input. + + ' + type: string + maxLength: 5400 + PublicKeyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PublicKeyResponse' + PublicKeyResponse: + type: object + properties: + items: + description: A list of public key objects. + type: array + items: + $ref: '#/components/schemas/PublicKey' + PublicKeyUseGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/PublicKeyUseResponse' + QosPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_context' + - type: object + properties: + max_total_bytes_per_sec: + description: 'The maximum allowed bytes/s totaled across all the clients. + + Throttling occurs when the total bandwidth exceeds this limit. + + Minimum limit is 1MB/s and maximum limit is 512GB/s. + + If not specified at creation time, defaults to `null` to indicate no + limit. + + ' + type: integer + format: int64 + minimum: 1048576 + maximum: 549755813888 + max_total_ops_per_sec: + description: 'The maximum allowed operations/s totaled across all the + clients. + + Throttling occurs when the total IOPs exceeds this limit. + + Minimum limit is 100 IOPs/s and maximum limit is 100M IOPs/s. + + If not specified at creation time, defaults to `null` to indicate no + limit. + + ' + type: integer + format: int64 + minimum: 100 + maximum: 100000000 + QosPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/QosPoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + QosPoliciesResponse: + type: object + properties: + items: + description: A list of QoS policy objects. + type: array + items: + $ref: '#/components/schemas/QosPolicy' + GroupQuotaPost: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + required: + - quota + properties: + quota: + description: 'The space limit of the quota (in bytes) for the specified + group, cannot + + be `0`. If specified, this value will override the file system''s default + + group quota. + + ' + type: integer + format: int64 + GroupQuotaPatch: + allOf: + - $ref: '#/components/schemas/GroupQuotaPost' + GroupQuotaGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/GroupQuotaResponse' + - $ref: '#/components/schemas/_errorContextResponse' + GroupQuotaResponse: + type: object + properties: + items: + description: A list of quota objects. + type: array + items: + $ref: '#/components/schemas/GroupQuota' + QuotaSetting: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + contact: + description: 'The contact information that will be provided in any notifications + + sent directly to users and groups. This can be an email, a phone + + number, a name, or some other form of contact information. + + ' + type: string + example: John Doe, john@example.com + direct_notifications_enabled: + description: 'Are notifications regarding space usage and quotas being + sent directly + + to user and group emails? + + ' + type: boolean + QuotaSettingGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/QuotaSettingResponse' + QuotaSettingResponse: + type: object + properties: + items: + description: A list of quota settings objects. + type: array + items: + $ref: '#/components/schemas/QuotaSetting' + UserQuotaPost: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + required: + - quota + properties: + quota: + description: 'The limit of the quota (in bytes) for the specified user, + cannot be `0`. + + If specified, this value will override the file system''s default user + + quota. + + ' + type: integer + format: int64 + UserQuotaPatch: + allOf: + - $ref: '#/components/schemas/UserQuotaPost' + UserQuotaGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/UserQuotaResponse' + - $ref: '#/components/schemas/_errorContextResponse' + UserQuotaResponse: + type: object + properties: + items: + description: A list of quota objects. + type: array + items: + $ref: '#/components/schemas/UserQuota' + 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/PageInfo' + - $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' + RapidDataLocking: + type: object + properties: + enabled: + description: '`True` if the Rapid Data Locking feature is enabled. + + ' + type: boolean + example: true + kmip_server: + description: 'The KMIP server configuration associated with RDL. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + RapidDataLockingResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/RapidDataLocking' + RealmPatch: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + default_inbound_tls_policy: + description: 'The default TLS policy governing inbound traffic from clients + accessing the accessing the realm''s + + network interfaces. This TLS policy will be applied for any IP addresses + within the realm that do not + + have a specific policy applied to them at a more granular level. If + no `default_inbound_tls_policy` + + is configured, then IP addresses within the realm that do not have a + specific policy + + applied to them at a more granular level will not be accessible using + TLS. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + 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 + + by setting `destroyed=false`. + + ' + type: boolean + RealmGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/RealmResponse' + - properties: + total: + $ref: '#/components/schemas/Realm' + RealmResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Realm' + RealmDefaults: + allOf: + - $ref: '#/components/schemas/_context' + - type: object + properties: + object_store: + type: array + description: Default configurations for object store. + items: + title: ObjectStoreDefault + allOf: + - $ref: '#/components/schemas/_objectStoreDefault' + realm: + description: Realm for the defaults. + readOnly: true + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + RealmDefaultsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/RealmDefaultsResponse' + - $ref: '#/components/schemas/_errorContextResponse' + RealmDefaultsResponse: + type: object + properties: + items: + description: A list of realm default configurations. + type: array + items: + $ref: '#/components/schemas/RealmDefaults' + RealmSpaceGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + description: A list of realm space metrics objects. + type: array + items: + $ref: '#/components/schemas/RealmSpace' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no items will be returned. + + ' + type: array + items: + $ref: '#/components/schemas/RealmSpace' + RealmSpaceStorageClassGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/RealmSpaceStorageClass' + description: A list of realm space metrics objects for each storage class. + total: + $ref: '#/components/schemas/RealmSpaceStorageClass' + 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' + ResiliencyGroupGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ResiliencyGroupResponse' + ResiliencyGroupMemberGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ResiliencyGroupMemberResponse' + ResourceAccessesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfoScale' + - $ref: '#/components/schemas/ResourceAccessesResponse' + ResourceAccessPost: + type: object + properties: + resource: + description: Resource to which the scope has access to. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + scope: + description: Scope which has access to the resource. + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + ResourceAccessesResponse: + type: object + properties: + items: + description: A list of resource access objects. + type: array + items: + $ref: '#/components/schemas/ResourceAccess' + RoleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Role' + S3ExportPolicyPost: + type: object + properties: + enabled: + type: boolean + example: true + rules: + type: array + items: + $ref: '#/components/schemas/_s3ExportPolicyRuleInlined' + S3ExportPolicyPatch: + type: object + properties: + enabled: + type: boolean + example: true + name: + type: string + description: New name of the S3 export policy. + rules: + type: array + items: + $ref: '#/components/schemas/_s3ExportPolicyRuleInlined' + S3ExportPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/S3ExportPolicyResponse' + - $ref: '#/components/schemas/_errorContextResponse' + S3ExportPolicyResponse: + type: object + properties: + items: + description: A list of S3 export policy objects. + type: array + items: + $ref: '#/components/schemas/S3ExportPolicy' + S3ExportPolicyRulePost: + type: object + properties: + actions: + description: 'The list of actions granted by this rule. Each included action + may + + restrict other properties of the rule. + + The only currently supported action is `pure:S3Access`. + + ' + type: array + items: + type: string + example: + - pure:S3Access + 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. + + The currently supported effects are `allow` and `deny`. + + ' + type: string + example: allow + resources: + description: 'The list of resources from the account to which this rule + applies to. + + The only currently supported resource type is buckets. + + ' + type: array + items: + type: string + example: + - '*' + - mybucket + - mybucket* + S3ExportPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/S3ExportPolicyRuleResponse' + - $ref: '#/components/schemas/_errorContextResponse' + S3ExportPolicyRuleResponse: + type: object + description: A list of S3 export policy rule objects. + properties: + items: + type: array + items: + $ref: '#/components/schemas/S3ExportPolicyRule' + OidcSsoPost: + type: object + properties: + enabled: + description: If set to `true`, the OIDC SSO configuration is enabled. + type: boolean + idp: + $ref: '#/components/schemas/_oidcSsoPostIdp' + prn: + description: Pure Resource Name of the identity provider + type: string + readOnly: true + example: prn::iam:array-id/local::oidc-provider/myidp + services: + description: 'Services that the OIDC SSO authentication is used for. + + Valid values: `object`. + + ' + type: array + items: + type: string + OidcSsoPatch: + allOf: + - $ref: '#/components/schemas/OidcSsoPost' + - type: object + properties: + name: + description: A new name for the provider + type: string + OidcSsoGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/OidcSsoResponse' + OidcSsoResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/OidcSso' + Saml2SsoPost: + type: object + properties: + array_url: + description: The URL of the array. + type: string + example: https://myarray.mycompany.com + binding: + description: 'SAML2 binding to use for the request from Flashblade to the + Identity + + Provider. + + Valid values: `http-redirect`, `none`. + + Defaults to `http-redirect`. + + ' + type: string + enabled: + description: If set to `true`, the SAML2 SSO configuration is enabled. + type: boolean + idp: + $ref: '#/components/schemas/_saml2SsoIdp' + prn: + description: Pure Resource Name of the identity provider + type: string + readOnly: true + example: prn::iam:array-id/local::saml-provider/myidp + services: + description: 'Services that the SAML2 SSO authentication is used for. + + Valid values: `management`, `object`. + + Defaults to `management`. + + ' + type: array + items: + type: string + sp: + $ref: '#/components/schemas/_saml2SsoSp' + Saml2Sso: + description: 'Configuration information for SAML2-based SSO for FlashArray. + + ' + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/Saml2SsoPost' + Saml2SsoGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/Saml2SsoResponse' + Saml2SsoResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Saml2Sso' + StorageClassTieringPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + archival_rules: + description: 'The list of archival rules for this policy. + + ' + type: array + items: + $ref: '#/components/schemas/TieringPolicyArchivalRule' + retrieval_rules: + description: 'The list of retrieval rules for this policy. + + ' + type: array + items: + $ref: '#/components/schemas/TieringPolicyRetrievalRule' + StorageClassTieringPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/StorageClassTieringPoliciesResponse' + StorageClassTieringPoliciesResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/StorageClassTieringPolicy' + description: A list of storage class tiering policy objects. + StorageClassTieringPoliciesMembersGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/StorageClassTieringPoliciesMembersResponse' + - $ref: '#/components/schemas/_errorContextResponse' + ServerPost: + type: object + properties: + dns: + description: 'The DNS config to be used by this server. + + ' + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/_reference' + ServerGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/ServerResponseContext' + - $ref: '#/components/schemas/_errorContextResponse' + ServerResponse: + type: object + properties: + items: + description: A list of server objects. + type: array + items: + $ref: '#/components/schemas/Server' + SessionGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Session' + SmbClientPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - 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 + rules: + description: 'All of the rules that are part of this policy. The order + is the + + evaluation order. + + ' + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbClientPolicyRulePostInPolicy' + SmbClientPolicyPatch: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - 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 + rules: + description: 'All of the rules that are part of this policy. The order + is the + + evaluation order. + + ' + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbClientPolicyRuleInPolicy' + SmbClientPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SmbClientPolicyResponse' + - $ref: '#/components/schemas/_errorContextResponse' + SmbClientPolicyResponse: + type: object + properties: + items: + description: A list of SMB Client policy objects. + type: array + items: + $ref: '#/components/schemas/SmbClientPolicy' + SmbClientPolicyRulePost: + allOf: + - $ref: '#/components/schemas/SmbClientPolicyRulePostBase' + - $ref: '#/components/schemas/_policyRuleIndex' + SmbClientPolicyRule: + allOf: + - $ref: '#/components/schemas/SmbClientPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndex' + - $ref: '#/components/schemas/_context' + SmbClientPolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SmbClientPolicyRuleResponse' + - $ref: '#/components/schemas/_errorContextResponse' + SmbClientPolicyRuleResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SmbClientPolicyRule' + SmbSharePolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + rules: + description: 'All of the rules that are part of this policy. + + ' + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbSharePolicyRulePost' + SmbSharePolicyPatch: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - type: object + properties: + rules: + description: 'All of the rules that are part of this policy. + + ' + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbSharePolicyRule' + SmbSharePolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SmbSharePolicyResponse' + - $ref: '#/components/schemas/_errorContextResponse' + SmbSharePolicyResponse: + type: object + properties: + items: + description: A list of SMB Share policy objects. + type: array + items: + $ref: '#/components/schemas/SmbSharePolicy' + SmbSharePolicyRulePost: + allOf: + - $ref: '#/components/schemas/_builtIn' + - 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`. + + ' + 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`. + + ' + 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`. + + ' + 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`. + + ' + type: string + SmbSharePolicyRule: + allOf: + - $ref: '#/components/schemas/_builtIn' + - 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`, and + + clears the Full Control permission if it is currently `allow`. This + is + + incompatible with explicitly setting any permission to `allow`. + + If set to an empty string (`""`), the value (and implicitly the Full + + Control permission) will be cleared. This is incompatible with + + explicitly setting the Full Control permission to `allow` or `deny`. + + ' + 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`. + + If set to an empty string (`""`), the value will be cleared. + + ' + type: string + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + principal: + description: 'The user or group who is the subject of this rule, and their + domain. + + If modifying this value, providing the domain is optional. If no domain + + is provided, it will be derived if possible. + + For example, `PURESTORAGE\Administrator`, `samplegroup@PureStorage`, + or + + `sampleuser`. + + ' + 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. + + If set to `allow`, implicitly clears the Full Control and Change + + permissions if they are currently `deny`. This is incompatible with + + explicitly setting any permission to `deny`. + + If set to `deny`, implicitly clears the Full Control and Change + + permissions if they are currently `allow`. This is incompatible with + + explicitly setting any permission to `allow`. + + ' + type: string + SmbSharePolicyRuleGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SmbSharePolicyRuleResponse' + - $ref: '#/components/schemas/_errorContextResponse' + SmbSharePolicyRuleResponse: + type: object + properties: + items: + description: A list of SMB Share policy rule objects. + type: array + items: + $ref: '#/components/schemas/SmbSharePolicyRuleWithContext' + SmtpServer: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + encryption_mode: + description: 'Enforces an encryption mode when sending alert email messages. + + Valid values include `starttls`. + + Use "" to clear. + + ' + type: string + example: starttls + 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 + SmtpServerGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SmtpServerResponse' + SmtpServerResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SmtpServer' + SnmpAgent: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + engine_id: + description: 'An SNMP agent''s adminstration domain unique name. + + ' + 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 an SNMP manager + + in communications with Purity''s SNMP agent. + + 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' + SnmpAgentMibResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SnmpAgentMib' + SnmpManagerPost: + type: object + properties: + host: + description: 'DNS hostname or IP address of a computer that hosts an SNMP + manager + + to which Purity 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 in communications + + with the specified manager. + + Valid values are `v2c` and `v3`. + + ' + type: string + example: v3 + SnmpManager: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + host: + description: 'DNS hostname or IP address of a computer that hosts an SNMP + manager + + to which Purity 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 in communications + + 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' + TestResultGetResponse: + allOf: + - $ref: '#/components/schemas/TestResultResponse' + - type: object + properties: + total_item_count: + description: Total number of items after applying `filter` params. + type: integer + format: int32 + SshCertificateAuthorityPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + signing_authority: + description: 'A reference to the authority that will digitally sign user + SSH certificates that will be + + used to access the system. + + This may be either a certificate or a public key. If a certificate is + used as the signer, + + then its expiry period will be honored and user SSH certificates signed + by the certificate + + will no longer be accepted after the certificate has expired. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + static_authorized_principals: + description: 'If not specified - users affected by this policy can only + log into the system when they + + present an SSH certificate containing their own username as a principle. + + If specified - users affected by this policy can only log into the system + when they + + present an SSH certificate containing at least one username from this + list as a + + principle. + + ' + type: array + maxItems: 16 + items: + maxLength: 128 + type: string + description: 'A specific principal that can be used to permit login + to user accounts to whom this + + policy applies. Principals must be comprised of UTF-8 encoded characters + and may + + not contain any of the following: `"`, `,`, `/`, newline character, + or other similar + + escape characters. + + ' + SshCertificateAuthorityPolicy: + allOf: + - $ref: '#/components/schemas/SshCertificateAuthorityPolicyPost' + - $ref: '#/components/schemas/PolicyBaseRenameable' + SshCertificateAuthorityPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SshCertificateAuthorityPolicyResponse' + SshCertificateAuthorityPolicyResponse: + type: object + properties: + items: + description: A list of SSH certificate authority policy objects. + type: array + items: + $ref: '#/components/schemas/SshCertificateAuthorityPolicy' + Subnet: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + enabled: + description: 'Indicates if subnet is enabled (`true`) or disabled (`false`). + + If not specified, defaults to `true`. + + ' + type: boolean + readOnly: true + gateway: + description: 'The IPv4 or IPv6 address of the gateway through which the + specified + + subnet is to communicate with the network. + + ' + type: string + interfaces: + description: List of network interfaces associated with this subnet. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + link_aggregation_group: + description: Reference to the associated LAG. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + 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 + example: 1.2.3.0/24 + 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 `data`, `management`, `replication`, + and `support`. + + ' + vlan: + description: VLAN ID. + type: integer + format: int32 + SubnetGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SubnetResponse' + SubnetResponse: + type: object + properties: + items: + description: A list of subnet objects. + type: array + items: + $ref: '#/components/schemas/Subnet' + Support: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + edge_agent_update_enabled: + description: The switch to enable opt-in for edge agent updates. + type: boolean + edge_management_enabled: + description: The switch to enable opt-in for edge management. + type: boolean + phonehome_enabled: + description: The switch to enable phonehome. + type: boolean + proxy: + type: string + remote_assist_active: + description: The switch to open all remote-assist sessions. + 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 time when the session expires. + type: string + readOnly: true + remote_assist_opened: + description: The time when the session opened. + type: string + readOnly: true + remote_assist_paths: + type: array + readOnly: true + items: + $ref: '#/components/schemas/_support_remote_assist_paths' + remote_assist_status: + description: 'The status of the remote-assist sessions. + + Valid values are `connected`, `partially_connected`, `reconnecting`, + + and `disconnected`. + + ' + type: string + readOnly: true + example: connected + SupportGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SupportResponse' + SupportResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Support' + VerificationKeyPatch: + type: object + properties: + signed_verification_key: + description: The text of the signed verification key. + type: string + VerificationKeyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/VerificationKeyResponse' + VerificationKeyResponse: + type: object + properties: + items: + description: A list of verification key objects. + type: array + items: + $ref: '#/components/schemas/VerificationKey' + SupportDiagnosticsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SupportDiagnosticsResponse' + SupportDiagnosticsDetailsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SupportDiagnosticsDetailsResponse' + SoftwareChecksGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SoftwareChecksResponse' + SoftwareChecksResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SoftwareCheck' + SyslogServerPost: + allOf: + - $ref: '#/components/schemas/SyslogServerPostOrPatch' + - type: object + properties: + services: + description: 'Valid values are `data-audit` and `management`. + + If not specified, defaults to `management`. + + ' + type: array + items: + type: string + sources: + description: 'The network interfaces used for communication with the syslog + server. + + The network interfaces must have the `services` value of `data`. + + Only network interfaces within default array realm are supported. + + ' + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/_reference' + SyslogServerPatch: + allOf: + - $ref: '#/components/schemas/SyslogServerPostOrPatch' + - type: object + properties: + services: + description: 'Valid values are `data-audit` and `management`. + + ' + type: array + items: + type: string + sources: + description: 'The network interfaces used for communication with the syslog + server. + + The network interfaces must have the `services` value of `data`. + + Only network interfaces within default array realm are supported. + + Clear this by setting an empty list. + + ' + type: array + maxItems: 1 + items: + $ref: '#/components/schemas/_reference' + SyslogServerGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SyslogServerContextResponse' + - $ref: '#/components/schemas/_errorContextResponse' + SyslogServerResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SyslogServer' + SyslogServerSettings: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: Global settings for syslog servers. + type: object + properties: + ca_certificate: + type: object + allOf: + - $ref: '#/components/schemas/_reference' + - description: 'CA certificate used to validate the authenticity of the + configured + + servers. + + ' + type: object + ca_certificate_group: + type: object + allOf: + - $ref: '#/components/schemas/_reference' + - description: 'A certificate group containing CA certificates that can + be used to + + validate the authenticity of the configured servers. + + ' + type: object + SyslogServerSettingsGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/SyslogServerSettingsResponse' + SyslogServerSettingsResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SyslogServerSettings' + TargetPost: + type: object + properties: + address: + description: IP address or FQDN of the target system. + type: string + Target: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + address: + description: IP address or FQDN of the target system. + type: string + ca_certificate_group: + description: 'The group of CA certificates that can be used, in addition + to + + well-known Certificate Authority certificates, in order to + + establish a secure connection to the target system. + + Defaults to a reference to the `_default_replication_certs` group. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + status: + description: 'Status of the connection. + + Valid values are `connected` and `connecting`. + + `connected` - The connection is OK. + + `connecting` - No connection exists and the array is trying to + + reconnect to the target. + + ' + 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 + TargetGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/TargetResponseContext' + - $ref: '#/components/schemas/_errorContextResponse' + TargetResponse: + type: object + properties: + items: + description: A list of target objects. + type: array + items: + $ref: '#/components/schemas/Target' + ResourcePerformanceReplicationGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ResourcePerformanceReplication' + total: + description: 'Total of all records after filtering. + + If `total_only` query param is `true`, then no items will be returned. + + ' + type: array + items: + $ref: '#/components/schemas/ResourcePerformanceReplication' + TlsPolicyPost: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - type: object + properties: + appliance_certificate: + description: 'A reference to a certificate that will be presented as the + server certificate + + in TLS negotiations with any clients that connect to appliance network + addresses + + to which this policy applies. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + client_certificates_required: + description: 'If `true`, then all clients negotiating TLS connections + with network + + interfaces to which this policy applies will be required to provide + + their client certificates during TLS negotiation. Any client''s failure + + to provide a certificate will cause the TLS negotiation to be + + rejected. + + If `false`, then providing a client certificate in TLS negotiation is + + not mandatory, and TLS negotiation can succeed when none is provided. + + If not specified, defaults to `false`. + + ' + type: boolean + disabled_tls_ciphers: + description: 'If specified, disables the specific TLS ciphers. If all + TLS ciphers + + that are available for a specific TLS version on the system are disabled, + then client + + access over that TLS version is not possible. As such, disabled ciphers + must still + + result in at least one cipher being available for each enabled TLS version. + + Changes to this setting can disrupt traffic for any clients relying + on disabled + + ciphers. + + ' + type: array + maxItems: 16 + items: + maxLength: 128 + type: string + description: 'A specific TLS cipher or TLS cipher component to disable, + in openssl format. + + For example, `AES128` would disable all TLS ciphers that utilize the + `AES128` + + algorithm for encryption, while `ECDHE-ECDSA-AES256-CCM` would disable + + that specific cipher. + + ' + enabled_tls_ciphers: + description: 'If specified, enables only the specified TLS ciphers. If + all TLS ciphers + + that are available for a specific TLS version on the system are disabled, + then client + + access over that TLS version is not possible. As such, the enabled ciphers + must always + + contain at least one cipher for each enabled TLS version. + + Changes to this setting can disrupt traffic for any clients relying + on ciphers that + + are removed. If set to `default`, then the enabled ciphers may be automatically + adjusted + + upon upgrade to newer software in order to align with the best known + practices at the + + time of software release. + + ' + type: array + maxItems: 16 + items: + maxLength: 128 + type: string + description: 'A specific TLS cipher or TLS cipher component to enable, + in openssl format. + + For example, `AES128` would enable all strong TLS ciphers that utilize + the `AES128` + + algorithm for encryption, while `AES128-SHA` would enable that specific + cipher. + + ' + min_tls_version: + description: 'The minimum TLS version that will be allowed for inbound + connections on IPs to + + which this policy applies. Changing this setting can disrupt connections + for + + any clients relying on older TLS versions that are disabled. + + If set to `default`, then the lowest TLS version permitted may be automatically + + raised upon upgrade to newer software in order to align with the best + known + + practices at the time of software release. + + Configuring an explicit, low value can prevent upgrades to newer software + + versions that no longer support older TLS versions. + + Valid values include `default`, `TLSv1.1`, `TLSv1.0`, `TLSv1.2`, + + and `TLSv1.3`. + + ' + type: string + trusted_client_certificate_authority: + description: 'A reference to a certificate or certificate group. + + The certificate referenced, or the certificates in the referenced group, + + will be used to verify the certificates presented by clients when + + `verify_client_certificate_trust` is `true`. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + verify_client_certificate_trust: + description: 'If `true`, then any certificate presented by a client in + TLS negotiation + + will undergo strict trust verification using the certificate(s) referenced + + by `trusted_client_certificate_authority`. + + If `false`, then certificates presented by clients in TLS negotiation + + will only be checked to ensure they''re properly constructed and non-expired, + + and the certificates specified by `trusted_client_certificate_authority` + will + + not be used. Details of client certificates may still be recorded for + certain + + audit purposes, even if they do not undergo trust verification. + + If `client_certificates_required` is `false`, and no client certificate + is + + provided during TLS negotiation, then no trust verification will be + performed; + + if a client chooses to provide a certificate, even when not required, + and + + this field is `true`, then the certificate will undergo trust verification. + + If not specified, defaults to `false`. + + ' + type: boolean + TlsPolicy: + allOf: + - $ref: '#/components/schemas/TlsPolicyPost' + - $ref: '#/components/schemas/PolicyBaseRenameable' + TlsPolicyGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/TlsPolicyResponse' + TlsPolicyResponse: + type: object + properties: + items: + description: A list of TLS policy objects. + type: array + items: + $ref: '#/components/schemas/TlsPolicy' + 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/PageInfo' + - $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: FixedReferenceWithoutType + allOf: + - $ref: '#/components/schemas/_fixedReferenceWithoutType' + 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' + - $ref: '#/components/schemas/_errorContextResponse' + WorkloadPlacementRecommendationResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/WorkloadPlacementRecommendation' + TagGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/TagResponse' + - $ref: '#/components/schemas/_errorContextResponse' + 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: ReferenceWithoutType + allOf: + - $ref: '#/components/schemas/_referenceWithoutType' + 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' + WormDataPolicy: + allOf: + - $ref: '#/components/schemas/SnapshotWormDataPolicyBase' + - $ref: '#/components/schemas/_wormDataPolicyRetentionConfig' + - $ref: '#/components/schemas/_context' + - type: object + properties: + realms: + description: 'The realms containing this worm data policy. + + ' + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + WormDataPoliciesGetResponse: + allOf: + - $ref: '#/components/schemas/PageInfo' + - $ref: '#/components/schemas/WormDataPoliciesResponse' + - $ref: '#/components/schemas/_errorContextResponse' + WormDataPoliciesResponse: + type: object + properties: + items: + description: A list of worm data policy objects. + type: array + items: + $ref: '#/components/schemas/WormDataPolicy' + _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' + ActiveDirectoryDirectoryServers: + type: object + properties: + directory_servers: + description: 'A list of directory servers that will be used for lookups + related to user authorization. + + Accepted server formats are IP address and DNS name with optional @domain + suffix. + + If the suffix is ommited, the joined domain is assumed. + + All specified servers must be registered to the domain appropriately in + the array''s + + configured DNS and will only be communicated with over the secure LDAP + (LDAPS) protocol. + + The specified list can have a maximum length of 50. + + ' + type: array + maxItems: 50 + items: + type: string + example: ldap.my-corporation.com + global_catalog_servers: + description: 'A list of global catalog servers that will be used for lookups + related to user authorization. + + Accepted server formats are IP address and DNS name with optional @domain + suffix. + + If the suffix is ommited, the joined domain is assumed. + + All specified servers must be registered to the domain appropriately in + the array''s + + configured DNS and will only be communicated with over the secure LDAP + (LDAPS) protocol. + + The specified list can have a maximum length of 50. + + ' + type: array + maxItems: 50 + items: + type: string + example: gc.my-corporation.com + 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 + total_item_count: + description: Total number of items after applying `filter` params. + type: integer + format: int32 + ActiveDirectory: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + computer_name: + description: 'The common 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: FLASHBLADE01 + directory_servers: + description: 'A list of directory servers that will be used for lookups + related to user authorization. + + Accepted server formats are IP address and DNS name with optional @domain + suffix. + + If the suffix is ommited, the joined domain is assumed. + + All specified servers must be registered to the domain appropriately + in the array''s + + configured DNS and will only be communicated with over the secure LDAP + (LDAPS) protocol. + + ' + type: array + items: + type: string + example: ldap.my-corporation.com + domain: + description: The Active Directory domain to join. + type: string + example: my-corporation.com + encryption_types: + description: 'The encryption types that are supported for use by clients + for Kerberos + + authentication. + + ' + type: array + items: + type: string + example: aes256-cts-hmac-sha1-96 + global_catalog_servers: + description: 'A list of global catalog servers that will be used + + for lookups related to user authorization. + + Accepted server formats are IP address and DNS name with optional @domain + suffix. + + If the suffix is ommited, the joined domain is assumed. + + All specified servers must be registered to the domain appropriately + in the array''s + + configured DNS and will only be communicated with over the secure LDAP + (LDAPS) protocol. + + ' + type: array + items: + type: string + example: gc.my-corporation.com + join_ou: + description: 'The relative distinguished name of the organizational unit + in which the + + computer account was created when joining the domain. + + ' + type: string + example: CN=Computers + kerberos_servers: + description: 'A list of key distribution servers to use for Kerberos protocol. + + Accepted server formats are IP address and DNS name. + + All specified servers must be registered to the domain appropriately + in the array''s + + configured DNS. + + ' + type: array + items: + type: string + example: krb-host.my-corporation.com + realms: + description: 'The realms containing this active directory account. + + ' + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + server: + description: 'The server containing this active directory account. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + service_principal_names: + description: 'A list of service principal names registered for the machine + account, + + which can be used for the creation of keys for Kerberos authentication. + + ' + type: array + items: + pattern: (service)/(fqdn) + type: string + example: nfs/vip1.my-array.my-corporation.com + _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' + _referenceWritable: + allOf: + - $ref: '#/components/schemas/_referenceWithoutType' + - type: object + properties: + resource_type: + description: 'Type of the object (full name of the endpoint). + + Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, + + `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, + + `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and + + `policies/snapshot`, etc. + + ' + type: string + x-aliases: + - _reference + Admin: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + api_token: + $ref: '#/components/schemas/_apiToken' + is_local: + description: Returns a value of `true` if the user is local to the machine, + otherwise `false`. + type: boolean + readOnly: true + locked: + description: 'Returns a value of `true` if the user is currently locked + out, otherwise `false`. + + Can be patched 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, in milliseconds, if the user + is locked out. + + 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. + + ' + readOnly: true + type: array + items: + $ref: '#/components/schemas/_fixedReference' + public_key: + description: Public key for SSH access. Supported key types are `Ed25519` + and `RSA`. + type: string + role: + description: 'Deprecated. + + `role` is deprecated in favor of `management_access_policies`, but remains + for + + backwards compatibility. If an administrator has exactly one access + policy which + + corresponds to a valid legacy role of the same name, `role` will be + a + + reference to that role. + + Otherwise, it will be `null`. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + AdminApiToken: + type: object + properties: + admin: + description: A reference to the admin to whom this token belongs. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + api_token: + title: ApiToken + allOf: + - $ref: '#/components/schemas/_apiToken' + x-readOnly: true + AdminCache: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + management_access_policies: + description: 'List of management access policies associated with the administrator. + + ' + readOnly: true + type: array + items: + $ref: '#/components/schemas/_fixedReference' + role: + description: 'Deprecated. + + `role` is deprecated in favor of `management_access_policies`, but remains + for + + backwards compatibility. If an administrator has exactly one access + policy which + + corresponds to a valid legacy role of the same name, `role` will be + a + + reference to that role. + + Otherwise, it will be `null`. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + time: + description: 'Time the role was cached in milliseconds since UNIX epoch. + + ' + type: integer + format: int64 + readOnly: true + x-readOnly: true + PolicyMember: + type: object + properties: + member: + description: Reference to the resource the policy is applied to. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy: + description: Reference to the policy. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + PolicyMemberContext: + allOf: + - $ref: '#/components/schemas/PolicyMember' + - $ref: '#/components/schemas/_context' + _builtIn: + type: object + properties: + id: + description: 'A non-modifiable, globally unique ID chosen by the system. + + ' + type: string + readOnly: true + name: + description: Name of the object (e.g., a file system or snapshot). + type: string + readOnly: true + 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: fm1 + 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: Is the service enabled or not? + type: boolean + example: true + resource: + description: A reference to the object being tested. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + result_details: + description: Additional information about the test result. + type: string + example: Timeout connecting to phonehome endpoint + success: + description: 'Returns a value of `true` if the specified test succeeded. + + Returns a value of `false` if the specified test 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. + + ' + type: string + example: phonehome + _fixedReference: + allOf: + - $ref: '#/components/schemas/_fixedReferenceWithoutType' + - type: object + properties: + resource_type: + description: 'Type of the object (full name of the endpoint). + + Valid values are the unique part of the resource''s REST endpoint. + + For example, a reference to a file system would have a + + `resource_type` of `file-systems`. + + ' + type: string + readOnly: true + _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 + _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: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + _arrayEncryption: + type: object + properties: + data_at_rest: + title: ArrayEncryptionDataAtRest + allOf: + - $ref: '#/components/schemas/_arrayEncryptionDataAtRest' + x-readOnly: true + _arrayEradicationConfig: + type: object + properties: + eradication_delay: + description: 'The file eradication delay is in milliseconds. + + Automatically eradicate destroyed filesystems and snapshots after the + delay time. + + Valid values are `86400000` and any multiple of `86400000` + + in the range of `86400000` and `2592000000`. + + Any other values will be rounded down to the + + nearest multiple of `86400000`. + + ' + type: integer + format: int64 + readOnly: true + example: 86400000 + manual_eradication: + description: 'Manual eradication status is applied on the array level. + + If status is all-disabled, you cannot eradicate buckets and file systems. + + If status is file-disabled then you can not eradicate files systems. + + If status is object-disabled then you can not eradicate buckets. + + If status is all-enabled then you can eradicate file systems and buckets. + + Values include `all-enabled`, `file-disabled`, + + `object-disabled`, and `all-disabled`. + + ' + type: string + readOnly: true + ClientsPerformance: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + bytes_per_op: + description: 'Average operation size (read bytes+write bytes/read ops+write + ops). + + ' + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + ClientsS3SpecificPerformance: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + read_buckets_per_sec: + description: Read buckets requests processed per second. + type: number + format: double + minimum: 0 + read_objects_per_sec: + description: Read object requests processed per second. + type: number + format: double + minimum: 0 + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + usec_per_read_bucket_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read bucket request. + + ' + type: number + format: double + minimum: 0 + usec_per_read_object_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read object request. + + ' + type: number + format: double + minimum: 0 + usec_per_write_bucket_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write bucket request. + + ' + type: number + format: double + minimum: 0 + usec_per_write_object_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write object request. + + ' + type: number + format: double + minimum: 0 + write_buckets_per_sec: + description: Write buckets requests processed per second. + type: number + format: double + minimum: 0 + write_objects_per_sec: + description: Write object requests processed per second. + type: number + format: double + minimum: 0 + _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/_builtInNoId' + - 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 7-digit number required as input to perform a factory + reset of the array. + + ' + type: integer + format: int64 + readOnly: true + example: 5671919 + _throttle: + description: 'The bandwidth throttling for an array connection or target. + + ' + 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 + _builtInRelationship: + type: object + properties: + id: + description: 'A non-modifiable, globally unique ID chosen by the system. + + ' + type: string + readOnly: true + ArrayConnectionKey: + type: object + properties: + connection_key: + description: 'Connection-key, used on another array to connect to this array. + + After creation, listing will only show ****. + + ' + type: string + readOnly: true + example: 6207d123-d123-0b5c-5fa1-95fabc5c7123 + created: + description: Creation time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + expires: + description: Expiration time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + x-readOnly: true + ArrayConnectionPath: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - $ref: '#/components/schemas/_context' + - description: 'Path from a source array to a destination array. + + `id` is the `id` of the array connection. + + ' + type: object + properties: + destination: + description: 'IP address with the port of the target array. + + ' + type: string + readOnly: true + example: 10.202.101.70:443 + remote: + description: 'The remote array. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + source: + description: 'IP address of the source array. + + ' + type: string + readOnly: true + example: 10.202.101.70 + status: + description: 'Status of the connection. + + Valid values are `connected` and `connecting`. + + `connected` - The connection is OK. + + `connecting` - No connection exists and the array is trying to + + reconnect. + + ' + 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` + and `fleet-management`. + + ' + type: string + ConnectionRelationshipPerformanceReplication: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - type: object + properties: + aggregate: + description: 'Total bytes transmitted or received per second for all types + of + + replication. + + ' + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + continuous: + description: 'Object backlog information and total bytes transmitted or + received + + per second for continuous replication. Continuous replication + + includes object replication. + + ' + title: ContinuousReplicationPerformance + allOf: + - $ref: '#/components/schemas/_continuousReplicationPerformance' + periodic: + description: 'Total bytes transmitted or received per second for periodic + + replication. Periodic replication includes file system replication, + + which is snapshot based. + + ' + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + remote: + description: Reference to a remote array. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + x-readOnly: true + ArrayHttpSpecificPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + read_dirs_per_sec: + description: Read directory requests processed per second. + type: number + format: double + minimum: 0 + read_files_per_sec: + description: Read file requests processed per second. + type: number + format: double + minimum: 0 + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + usec_per_read_dir_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read directory request. + + ' + type: number + format: double + minimum: 0 + usec_per_read_file_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read file request. + + ' + type: number + format: double + minimum: 0 + usec_per_write_dir_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write directory request. + + ' + type: number + format: double + minimum: 0 + usec_per_write_file_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write file request. + + ' + type: number + format: double + minimum: 0 + write_dirs_per_sec: + description: Write directory requests processed per second. + type: number + format: double + minimum: 0 + write_files_per_sec: + description: Write file requests processed per second. + type: number + format: double + minimum: 0 + ArrayNfsSpecificPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + accesses_per_sec: + description: ACCESS requests processed per second. + type: number + format: double + minimum: 0 + aggregate_file_metadata_creates_per_sec: + description: 'Sum of file-level or directory-level create-like metadata + requests per + + second. Includes CREATE, LINK, MKDIR, and SYMLINK. + + ' + type: number + format: double + minimum: 0 + aggregate_file_metadata_modifies_per_sec: + description: 'Sum of file-level or directory-level modify-like and delete-like + + metadata requests per second. Includes REMOVE, RENAME, RMDIR, and + + SETATTR. + + ' + type: number + format: double + minimum: 0 + aggregate_file_metadata_reads_per_sec: + description: 'Sum of file-level or directory-level read-like metadata + requests per + + second. Includes GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and + + READLINK. + + ' + type: number + format: double + minimum: 0 + aggregate_other_per_sec: + description: 'Sum of all other requests processed per second. This includes + COMMIT, + + MKNOD, NULL, NLM operations, and operations which are supported for + + NFSv4.1 but not NFSv3. + + ' + type: number + format: double + minimum: 0 + aggregate_share_metadata_reads_per_sec: + description: 'Sum of share-level read-like metadata requests per second. + + Includes ACCESS, FSINFO, and FSSTAT. + + ' + type: number + format: double + minimum: 0 + aggregate_usec_per_file_metadata_create_op: + description: 'Average time, measured in microseconds, it takes the array + to process a + + file-level or directory-level create-like metadata request. Includes + + CREATE, LINK, MKDIR, and SYMLINK. + + ' + type: number + format: double + minimum: 0 + aggregate_usec_per_file_metadata_modify_op: + description: 'Average time, measured in microseconds, it takes the array + to process a + + file-level or directory-level modify-like or delete-like metadata + + request. Includes REMOVE, RENAME, RMDIR, and SETATTR. + + ' + type: number + format: double + minimum: 0 + aggregate_usec_per_file_metadata_read_op: + description: 'Average time, measured in microseconds, it takes the array + to process a + + file-level or directory-level read-like metadata request. Includes + + GETATTR, LOOKUP, PATHCONF, READDIR, READDIRPLUS, and READLINK. + + ' + type: number + format: double + minimum: 0 + aggregate_usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + all other requests. This includes COMMIT, MKNOD, NULL, NLM operations, + + and operations which are supported for NFSv4.1 but not NFSv3. + + ' + type: number + format: double + minimum: 0 + aggregate_usec_per_share_metadata_read_op: + description: 'Average time, measured in microseconds, it takes the array + to process a + + share-level read-like metadata request. Includes ACCESS, FSINFO, and + + FSSTAT. + + ' + type: number + format: double + minimum: 0 + creates_per_sec: + description: CREATE requests processed per second. + type: number + format: double + minimum: 0 + fsinfos_per_sec: + description: FSINFO requests processed per second. + type: number + format: double + minimum: 0 + fsstats_per_sec: + description: FSSTAT requests processed per second. + type: number + format: double + minimum: 0 + getattrs_per_sec: + description: GETATTR requests processed per second. + type: number + format: double + minimum: 0 + links_per_sec: + description: LINK requests processed per second. + type: number + format: double + minimum: 0 + lookups_per_sec: + description: LOOKUP requests processed per second. + type: number + format: double + minimum: 0 + mkdirs_per_sec: + description: MKDIR requests processed per second. + type: number + format: double + minimum: 0 + pathconfs_per_sec: + description: PATHCONF requests processed per second. + type: number + format: double + minimum: 0 + readdirpluses_per_sec: + description: READDIRPLUS requests processed per second. + type: number + format: double + minimum: 0 + readdirs_per_sec: + description: READDIR requests processed per second. + type: number + format: double + minimum: 0 + readlinks_per_sec: + description: READLINK requests processed per second. + type: number + format: double + minimum: 0 + reads_per_sec: + description: READ requests processed per second. + type: number + format: double + minimum: 0 + removes_per_sec: + description: REMOVE requests processed per second. + type: number + format: double + minimum: 0 + renames_per_sec: + description: RENAME requests processed per second. + type: number + format: double + minimum: 0 + rmdirs_per_sec: + description: RMDIR requests processed per second. + type: number + format: double + minimum: 0 + setattrs_per_sec: + description: SETATTR requests processed per second. + type: number + format: double + minimum: 0 + symlinks_per_sec: + description: SYMLINK requests processed per second. + type: number + format: double + minimum: 0 + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + usec_per_access_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + an ACCESS request. + + ' + type: number + format: double + minimum: 0 + usec_per_create_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a CREATE request. + + ' + type: number + format: double + minimum: 0 + usec_per_fsinfo_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + an FSINFO request. + + ' + type: number + format: double + minimum: 0 + usec_per_fsstat_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + an FSSTAT request. + + ' + type: number + format: double + minimum: 0 + usec_per_getattr_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a GETATTR request. + + ' + type: number + format: double + minimum: 0 + usec_per_link_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a LINK request. + + ' + type: number + format: double + minimum: 0 + usec_per_lookup_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a LOOKUP request. + + ' + type: number + format: double + minimum: 0 + usec_per_mkdir_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a MKDIR request. + + ' + type: number + format: double + minimum: 0 + usec_per_pathconf_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a PATHCONF request. + + ' + type: number + format: double + minimum: 0 + usec_per_read_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a READ request. + + ' + type: number + format: double + minimum: 0 + usec_per_readdir_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a READDIR request. + + ' + type: number + format: double + minimum: 0 + usec_per_readdirplus_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a READDIRPLUS request. + + ' + type: number + format: double + minimum: 0 + usec_per_readlink_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a READLINK request. + + ' + type: number + format: double + minimum: 0 + usec_per_remove_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a REMOVE request. + + ' + type: number + format: double + minimum: 0 + usec_per_rename_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a RENAME request. + + ' + type: number + format: double + minimum: 0 + usec_per_rmdir_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + an RMDIR request. + + ' + type: number + format: double + minimum: 0 + usec_per_setattr_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a SETATTR request. + + ' + type: number + format: double + minimum: 0 + usec_per_symlink_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a SYMLINK request. + + ' + type: number + format: double + minimum: 0 + usec_per_write_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a WRITE request. + + ' + type: number + format: double + minimum: 0 + writes_per_sec: + description: WRITE requests processed per second. + type: number + format: double + minimum: 0 + ArrayPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + bytes_per_op: + description: 'Average operation size (read bytes+write bytes/read ops+write + ops). + + ' + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + RelationshipPerformanceReplication: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - $ref: '#/components/schemas/_context' + - type: object + properties: + aggregate: + description: 'Total bytes transmitted or received per second for all types + of + + replication. + + ' + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + continuous: + description: 'Object backlog information and total bytes transmitted or + received + + per second for continuous replication. Continuous replication + + includes object replication. + + ' + title: ContinuousReplicationPerformance + allOf: + - $ref: '#/components/schemas/_continuousReplicationPerformance' + periodic: + description: 'Total bytes transmitted or received per second for periodic + + replication. Periodic replication includes file system replication, + + which is snapshot based. + + ' + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + x-readOnly: true + ArrayS3SpecificPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + read_buckets_per_sec: + description: Read buckets requests processed per second. + type: number + format: double + minimum: 0 + read_objects_per_sec: + description: Read object requests processed per second. + type: number + format: double + minimum: 0 + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + usec_per_read_bucket_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read bucket request. + + ' + type: number + format: double + minimum: 0 + usec_per_read_object_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read object request. + + ' + type: number + format: double + minimum: 0 + usec_per_write_bucket_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write bucket request. + + ' + type: number + format: double + minimum: 0 + usec_per_write_object_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write object request. + + ' + type: number + format: double + minimum: 0 + write_buckets_per_sec: + description: Write buckets requests processed per second. + type: number + format: double + minimum: 0 + write_objects_per_sec: + description: Write object requests processed per second. + type: number + format: double + minimum: 0 + ArraySpace: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + capacity: + description: Usable capacity in bytes. + type: integer + format: int64 + example: 10995116277760 + parity: + description: 'A representation of data redundancy on the array. + + Data redundancy is rebuilt automatically by the system whenever parity + is less than 1.0. + + ' + type: number + format: float + example: 0.99 + space: + $ref: '#/components/schemas/_space' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + StorageClassSpace: + allOf: + - $ref: '#/components/schemas/_fixedReferenceNameOnly' + - type: object + properties: + capacity: + description: Usable capacity in bytes. + type: integer + format: int64 + example: 10995116277760 + space: + $ref: '#/components/schemas/_space' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + _timeZone: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + ArrayErasure: + allOf: + - $ref: '#/components/schemas/_resourceNoId' + - description: 'Status and detailed information of the factory reset process. + + ' + type: object + properties: + details: + description: 'The detailed reason of the `status`. + + ' + type: string + 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 + example: NIST SP800-88R1 section 4.8 ... + status: + description: 'The status of the factory reset process. + + A status of `resetting` indicates that the factory reset is running + - wiping user data. + + A status of `failed` indicates that the factory reset encountered a + failure. + + A status of `waiting_for_finalize` indicates that the factory reset + has + + finished - waiting for the user to finalize the factory reset. + + ' + type: string + example: resetting + AuditResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/Audit' + AuditFileSystemsPolicyNoContext: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_resource' + - properties: + control_type: + type: string + description: 'Specifies the evaluation mode for auditing in this policy. + + Valid values are "policy", "sacl". If not specified, the default value + is "sacl". + + ' + log_targets: + description: 'List of targets which will be utilized for audit log storage. + + These may either be file system targets or remote syslog server targets. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + rules: + type: array + maxItems: 2 + items: + $ref: '#/components/schemas/AuditFileSystemsPolicyRuleInPolicy' + description: 'All of the rules that are part of this policy. + + ' + AuditFileSystemsPolicyPatchBase: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_resource' + - properties: + log_targets: + description: 'List of targets which will be utilized for audit log storage. + + These may either be file system targets or remote syslog server targets. + + ' + type: array + items: + $ref: '#/components/schemas/_reference' + rules: + type: array + maxItems: 2 + items: + $ref: '#/components/schemas/AuditFileSystemsPolicyRuleInPolicy' + description: 'All of the rules that are part of this policy. + + ' + _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 + 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 + x-aliases: + - _referenceWithFixedType + AuditFileSystemsPolicy: + allOf: + - $ref: '#/components/schemas/AuditFileSystemsPolicyNoContext' + - $ref: '#/components/schemas/_context' + - type: object + properties: + control_type: + type: string + description: 'Specifies the evaluation mode for auditing in this policy. + + Valid values are "policy", "sacl". If not specified, the default value + is "sacl". + + ' + log_targets: + description: 'List of targets which will be utilized for audit log storage. + + These may either be file system targets or remote syslog server targets. + + ' + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + rules: + type: array + maxItems: 2 + items: + $ref: '#/components/schemas/AuditFileSystemsPolicyRuleInPolicy' + description: 'All of the rules that are part of this policy. + + ' + AuditFileSystemsPolicyOperationResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/AuditFileSystemsPolicyOperation' + AuditObjectStorePolicyWithWritableReference: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_resource' + - type: object + properties: + log_targets: + description: 'List of targets which will be utilized for audit log storage. + + These may either be bucket targets or remote syslog server targets. + + ' + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + AuditObjectStorePolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_resource' + - type: object + properties: + log_targets: + description: 'List of targets which will be utilized for audit log storage. + + These may either be bucket targets or remote syslog server targets. + + ' + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + AuditObjectStorePolicyWithContext: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/AuditObjectStorePolicy' + Blade: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + details: + type: string + readOnly: true + progress: + type: number + format: float + readOnly: true + raw_capacity: + type: integer + format: int64 + readOnly: true + status: + description: 'Valid values are `critical`, `evacuated`, `evacuating`, + `healthy`, + + `identifying`, `unhealthy`, `unknown`, and `unused`. + + ' + type: string + readOnly: true + target: + type: string + readOnly: true + BucketAuditFilterActionResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/BucketAuditFilterActionWithContext' + _bucketEradicationConfig: + description: Configuration settings related to bucket eradication. + type: object + properties: + eradication_delay: + description: 'Minimum eradication delay in milliseconds. Automatically eradicate + destroyed + + buckets after the delay time passes unless automatic eradication + + is delayed due to other configuration values. + + ' + type: integer + format: int64 + readOnly: true + example: 86400000 + eradication_mode: + description: 'The eradication mode of the bucket. + + If it''s `permission-based` the bucket can be eradicated based + + on user permissions. + + If it''s `retention-based` the bucket can never be eradicated as long + + as there are locked objects still being retained. + + Valid values are `permission-based` and `retention-based`. + + ' + type: string + example: permission-based + manual_eradication: + description: 'The manual eradication status of the bucket. + + If `disabled`, the bucket cannot be eradicated after it has been + + destroyed, unless it is empty. + + If `enabled`, the bucket can be eradicated. + + Valid values are `disabled` and `enabled`. + + ' + type: string + readOnly: true + example: enabled + _objectLockConfigRequestBody: + allOf: + - $ref: '#/components/schemas/_objectLockConfigBase' + - type: object + properties: + default_retention: + description: 'The retention period, in milliseconds, used to apply locks + + on new objects if none is specified by the S3 client. + + Valid values are any multiple of `86400000` (1 day), up to + + `3153600000000` (36500 days). + + If there is no default, this value is `null`. + + Use "" to clear. + + ' + type: string + example: '86400000' + _publicAccessConfig: + description: Configuration settings related to public access. + type: object + properties: + block_new_public_policies: + description: 'If set to `true`, adding bucket policies that grant public + access to a bucket is not allowed. + + ' + type: boolean + block_public_access: + description: 'If set to `true`, access to a bucket with a public policy + is restricted to only authenticated + + users within the account that bucket belongs to. + + ' + type: boolean + StorageClassInfo: + allOf: + - $ref: '#/components/schemas/_referenceNameOnly' + - type: object + properties: + status: + description: The status of the transition from the policy to the requested + policy. If there is an ongoing transition, the status will be one of + `In-Progress` or `Queued`. If there is no transition ongoing, this field + will be null. + type: string + readOnly: true + status_details: + description: Additional details about the status of the transition. If + there is no transition ongoing, this field will be null. + type: string + readOnly: true + tiering_policy: + description: 'The storage class tiering policy defines tiering for data + within the container. If specified, + + data is written to the container''s `S500X-S` (speed) storage class + by default, then tiered + + to `S500X-A` (archival) storage class based on the policy. + + If not specified, all data in the container is written to the container''s + current storage class. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + Bucket: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + account: + $ref: '#/components/schemas/_fixedReference' + bucket_type: + description: 'The bucket type for the bucket. + + ' + type: string + readOnly: true + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + destroyed: + description: 'Is the bucket destroyed? + + ' + type: boolean + eradication_config: + title: BucketEradicationConfig + allOf: + - $ref: '#/components/schemas/_bucketEradicationConfig' + hard_limit_enabled: + description: 'If set to `true`, the bucket''s size, as defined by `quota_limit`, + + is used as a hard limit quota. + + If set to `false`, a hard limit quota will not be applied to the + + bucket, but soft quota alerts will still be sent if the bucket has + + a value set for `quota_limit`. + + ' + type: boolean + object_count: + description: The count of objects within the bucket. + type: integer + format: int64 + readOnly: true + object_lock_config: + $ref: '#/components/schemas/_objectLockConfigResponse' + public_access_config: + $ref: '#/components/schemas/_publicAccessConfig' + public_status: + description: 'Bucket''s public status. Valid values include `bucket-and-objects-not-public`, + + `only-authorized-users-of-this-account` and `public`. + + ' + type: string + readOnly: true + example: bucket-and-objects-not-public + qos_policy: + description: 'The QoS policy for the bucket defines the performance controls + + that can be applied to the aggregate performance of all the clients + + accessing the bucket. + + If no policy is configured for a bucket, then no performance + + controls are applied to it. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + quota_limit: + description: 'The effective quota limit applied against the size of the + bucket, displayed in bytes. + + If unset, the bucket is unlimited in size. + + ' + type: integer + retention_lock: + description: 'If set to `ratcheted`, then `object_lock_config.default_retention_mode` + + cannot be changed if set to `compliance`. In this case, the value of + + `object_lock_config.default_retention` can only be increased and + + `object_lock_config.default_retention_mode` cannot be changed once set + + to `compliance`. + + Valid values are `unlocked` and `ratcheted`. + + Contact Pure Technical Services to change `ratcheted` to `unlocked`. + + ' + type: string + example: unlocked + space: + description: The space specification of the bucket. + title: Space + allOf: + - $ref: '#/components/schemas/_space' + storage_class: + $ref: '#/components/schemas/StorageClassInfo' + time_remaining: + description: 'Time in milliseconds before the bucket is eradicated. + + `null` if not destroyed or legal hold was found or the remaining time + + until eradication is not known yet. + + ' + type: integer + format: int64 + readOnly: true + time_remaining_status: + description: 'Status of the `time_remaining` field. + + `calculating` means the bucket is `retention-based`, has been destroyed + and the + + `time_remaining` is being calculated by a background process + + `legal-hold` means the bucket is `retention-based`, has been destroyed + and will never be + + eradicated, because an object with legal hold status was found inside. + + null otherwise, i.e. when either the bucket is not destroyed or it''s + destroyed and the + + `time_remaining` has been determined. + + ' + type: string + readOnly: true + example: calculating + versioning: + description: 'The versioning state for objects within the bucket. + + Valid values are `none`, `enabled`, and `suspended`. + + ' + type: string + BucketAuditFilterBase: + type: object + properties: + actions: + description: 'The list of ops to be audited by this filter. + + ' + type: array + items: + type: string + example: + - s3:GetObject + - s3:READ_OPS + - s3:WRITE_OPS + s3_prefixes: + description: 'The list of object name prefixes. The corresponding ops present + in this filter will be audited + + for the objects having these prefixes. + + ' + type: array + items: + type: string + example: + - prefix1 + - prefix2 + BucketAuditFilterWithContext: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/BucketAuditFilter' + CrossOriginResourceSharingPolicyRuleBulkManage: + allOf: + - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRulePost' + - type: object + properties: + name: + description: Name of the object (e.g., a file system or snapshot). + type: string + CrossOriginResourceSharingPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + bucket: + description: The bucket to which this policy belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + rules: + type: array + maxItems: 100 + items: + $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleWithContext' + CrossOriginResourceSharingPolicyRuleWithContext: + allOf: + - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRule' + - $ref: '#/components/schemas/_context' + BucketPerformanceItems: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + bytes_per_op: + description: 'Average operation size (read bytes+write bytes/read ops+write + ops). + + ' + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + max_total_bytes_per_sec: + description: Limit on throughput in bytes per bucket. + type: number + format: double + minimum: 0 + readOnly: true + max_total_ops_per_sec: + description: Limit on operation count per bucket. + type: number + format: double + minimum: 0 + readOnly: true + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + BucketPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + bytes_per_op: + description: 'Average operation size (read bytes+write bytes/read ops+write + ops). + + ' + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + BucketAccessPolicyRuleBulkManage: + allOf: + - $ref: '#/components/schemas/BucketAccessPolicyRulePost' + - type: object + properties: + name: + description: Name of the object (e.g., a file system or snapshot). + type: string + BucketAccessPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + bucket: + description: The bucket to which this policy belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + rules: + type: array + items: + $ref: '#/components/schemas/BucketAccessPolicyRule' + BucketAccessPolicyRulePrincipal: + type: object + properties: + all: + description: 'If `true`, the rule will apply to all object store users regardless + of their + + origin or principal. + + ' + type: boolean + BucketAccessPolicyRuleWithContext: + allOf: + - $ref: '#/components/schemas/BucketAccessPolicyRule' + - $ref: '#/components/schemas/_context' + BucketS3SpecificPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_buckets_per_sec: + description: Read buckets requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_objects_per_sec: + description: Read object requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_bucket_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read bucket request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_object_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read object request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_bucket_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write bucket request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_object_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write object request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + write_buckets_per_sec: + description: Write buckets requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + write_objects_per_sec: + description: Write object requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + _replicaLinkBuiltIn: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - type: object + properties: + direction: + $ref: '#/components/schemas/_direction' + 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 + status_details: + description: 'Detailed information about the status of the replica link + when it is + + unhealthy. + + ' + type: string + readOnly: true + _objectBacklog: + type: object + properties: + bytes_count: + description: 'The size of the objects in bytes that need to be replicated. + + This does not include the size of custom metadata. + + ' + type: integer + format: int64 + readOnly: true + delete_ops_count: + description: 'The number of DELETE operations that need to be replicated. + + ' + type: integer + format: int64 + readOnly: true + other_ops_count: + description: 'The number of other operations that need to be replicated. + + ' + type: integer + format: int64 + readOnly: true + put_ops_count: + description: 'The number of PUT operations that need to be replicated. + + ' + type: integer + format: int64 + readOnly: true + _fixedReferenceNameOnly: + type: object + properties: + name: + type: string + readOnly: true + x-readOnly: true + _certificateBase: + allOf: + - type: object + properties: + certificate: + description: The text of the certificate. + type: string + certificate_type: + description: 'The type of certificate. Possible values are `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. + + This field may only be specified at certificate creation time. + + If not specified at creation time, defaults to `external`. + + ' + type: string + common_name: + description: The common name field listed in the certificate. + type: string + country: + description: The country field listed in the certificate. + type: string + example: Canada + email: + description: The email field listed in the certificate. + type: string + example: tcrisp@example.com + intermediate_certificate: + description: Intermediate certificate chains. + type: string + issued_by: + description: Who issued this certificate. + type: string + readOnly: true + example: Example Incorporated + issued_to: + description: Who this certificate was issued to. + 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 + realms: + description: 'The realms containing this certificate. + + ' + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + 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: 1491070899000 + valid_to: + description: 'The date when the certificate stops being valid. + + ' + type: integer + format: int64 + readOnly: true + example: 152424849000 + Certificate: + allOf: + - description: SSL Certificate managed by Purity. + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_certificateBase' + Member: + type: object + properties: + group: + description: 'A reference to a group object that has the referenced member + object + + as a member. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + member: + description: 'A reference to an object that is a member of the referenced + group. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + CertificateSigningRequest: + description: 'SSL certificate managed by Purity. + + ' + type: object + properties: + certificate_signing_request: + description: 'The text of a new certificate signing request. + + ' + type: string + CertificateUse: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + group: + description: 'A reference to a certificate group that is being used, if + any, where + + this certificate is a member of the certificate-group. This field is + + `null` if the referenced use object is not using a group, but is rather + + using this certificate directly. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + use: + description: A reference to an object using this certificate. + title: FixedReferenceWithRemote + allOf: + - $ref: '#/components/schemas/_fixedReferenceWithRemote' + CertificateGroup: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + realms: + description: 'The realms containing this certificate group. + + ' + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + CertificateGroupUse: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + use: + description: A reference to an object using this certificate group. + title: FixedReferenceWithRemote + allOf: + - $ref: '#/components/schemas/_fixedReferenceWithRemote' + PolicyBase: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + PolicyBaseRenameable: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + enabled: + description: 'If `true`, the policy is enabled. If not specified, defaults + to `true`. + + ' + type: boolean + is_local: + description: Whether the policy is defined on the local array. + type: boolean + readOnly: true + location: + description: Reference to the array where the policy is defined. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy_type: + description: 'Type of the policy. Valid values include `alert`, `audit`, + `bucket-access`, + + `cross-origin-resource-sharing`, `network-access`, `nfs`, `object-access`, + + `s3-export`, smb-client`, `smb-share`, `ssh-certificate-authority`, + and + + `telemetry-metrics`. + + ' + type: string + readOnly: true + realms: + description: 'The realms containing this policy. + + ' + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + _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 + + 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 + _directoryServiceNfs: + description: Properties specific to the NFS service. + type: object + properties: + nis_domains: + description: NIS domains to search. + type: array + items: + type: string + example: ypdomain + nis_servers: + description: 'A list of the IP addresses or hostnames of NIS servers to + search. + + ' + type: array + items: + type: string + example: 181.44.543.12 + _directoryServiceSmb: + description: DEPRECATED - Properties specific to the SMB service. + type: object + properties: + join_ou: + description: 'Optional organizational unit where the machine account for + the directory service will be created. + + ' + type: string + example: OU=my_organizational_unit + TestResultWithContext: + allOf: + - $ref: '#/components/schemas/TestResult' + - $ref: '#/components/schemas/_context' + Drive: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + details: + description: 'Details about the status of the drive if not healthy. + + ' + type: string + readOnly: true + progress: + description: 'Reflects this drive''s current progress toward completing + a planned + + evacuation. If a planned evacuation is not occurring, the value will + + be `null`. + + ' + type: number + format: float + minimum: 0 + maximum: 1 + readOnly: true + raw_capacity: + type: integer + format: int64 + readOnly: true + status: + description: 'Current status of the drive. Valid values are `evacuated`, + + `evacuating`, `healthy`, `unhealthy`, `unused`, and `updating`. + + ' + type: string + readOnly: true + type: + description: 'The type of the module. Valid values are `DFM` and `DFMe`. + + ' + type: string + readOnly: true + example: DFM + _fileSystemEradicationConfig: + description: Configuration settings related to file system eradication. + type: object + properties: + eradication_mode: + description: 'The eradication mode of the file system. + + If it''s `permission-based` the file system can be eradicated based + + on user permissions. + + If it''s `retention-based` the file system can not be eradicated + + until no files/inodes are locked or retained. + + Valid values are `permission-based` and `retention-based`. + + ' + type: string + example: permission-based + manual_eradication: + description: 'The manual eradication status of the file system. + + If `disabled`, the file system cannot be eradicated after it has been + + destroyed, unless it is empty. + + If `enabled`, the file system can be eradicated. + + Valid values are `disabled` and `enabled`. + + ' + type: string + readOnly: true + example: enabled + _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/_reference' + - type: object + properties: + configuration: + description: 'The name of the preset configuration object. + + ' + type: string + _http: + type: object + properties: + enabled: + description: Is the protocol enabled? If not specified, defaults to `false`. + type: boolean + _multiProtocolPost: + 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. + + Defaults to `shared`. + + ' + 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`. + + Defaults to `true`. + + ' + type: boolean + _nfs: + type: object + properties: + export_policy: + description: 'Deprecated. See File System Exports for newer functionality. + + The value returned will be the `policy` of the File System + + Export for the default server, and NFS, with the `export_name` + + matching the file system name, if there is one and null otherwise. + + Modifying this field will still work. + + If the current value is null, then setting this field will attempt + + to create a File System Export with the policy + + and other default values. The `export_name` will be the same as the + + file system''s `name`. + + If the current value is not null, then setting this field will change + + the policy in the matching File System Export. + + Either the `export_policy` or `rules` will control the + + NFS export functionality for the file system. + + If this is set, then the `rules` field will be cleared. + + Both `export_policy` and `rules` can not be set in the same request. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + rules: + description: 'Deprecated. See File System Exports and NFS Export Policies + for newer functionality. + + Modifying this field will still work, causing the matching + + File System Export to be deleted, if there is one. See `export_policy`. + + Both `export_policy` and `rules` can not be set in the same request. + + Rules can be applied to an individual + + client or a range of clients specified by IP address (`ip_address(options)`), + + netmask (`ip_address/length(options)`), netgroup (`@groupname(options)`), + + hostname (`hostname(options)`) (see RFC-1123 part 2.1), fully qualified + domain name + + (`host.exampledomain.com(options)`) (see RFC-1123 part 2.1, RFC 2181 part + 11), or wildcards + + with fully qualified domain name or hostname (`*.exampledomain?.com(options)`). + + Possible export options include `rw`, `ro`, `fileid_32bit`, `no_fileid_32bit`, + + `anonuid`, `anongid`, `root_squash`, `no_root_squash`, `all_squash`, + + `no_all_squash`, `secure`, `insecure`, `atime`, `noatime`, and `sec`. + + If not specified, defaults to `*(rw,no_root_squash)`. + + ' + type: string + example: 1.0.0.0/8(rw,no_root_squash) fd01:abcd::/64(ro,secure,root_squash,anongid=16000) + @netgrp(rw,all_squash,anonuid=99,fileid_32bit) 1.41.8.32(rw,no_all_squash,sec=krb5:krb5i:krp5p) + my-hostname(rw,no_root_squash) host.exampledomain.com(rw,no_root_squash) + host?(rw,no_root_squash) host?.example*domain.com(rw,no_root_squash) host.*(rw,no_root_squash) + v3_enabled: + description: 'If set to `true`, the NFSv3 protocol will be enabled. + + ' + type: boolean + v4_1_enabled: + description: 'If set to `true`, the NFSv4.1 protocol will be enabled. + + ' + type: boolean + _smbPost: + allOf: + - $ref: '#/components/schemas/_smb' + - type: object + properties: + client_policy: + description: 'The SMB Client policy for the file system. Setting a policy + here grants + + access permissions (e.g. read-only or read-write) to the file system + via + + SMB on a per-client basis. + + Defaults to a pre-defined full access policy if none is specified. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + share_policy: + description: 'The SMB Share policy for the file system. Setting a policy + here + + grants access permissions (e.g. allow or deny Full Control, Change, + + and/or Read) to the file system via SMB on a per-user / per-group basis. + + Defaults to a pre-defined full access policy if none is specified. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _workloadConfigurationReferencePatch: + type: object + description: 'Set the `id` or `name` of the workload to an empty string to remove + the + + resource from the workload. + + ' + allOf: + - $ref: '#/components/schemas/_reference' + _multiProtocol: + 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. + + ' + 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`. + + ' + type: boolean + _nfsPatch: + allOf: + - $ref: '#/components/schemas/_nfs' + - type: object + properties: + add_rules: + description: 'The rules which will be added to the existing NFS export + rules for the + + file system. If `export_policy` is in use and and this field is set, + the operation + + will fail. + + ' + type: string + after: + description: 'The `after` field can be used with `add_rules` or `remove_rules` + or both. + + If used with `add_rules`, then the `add_rules` string will be inserted + after + + the first occurrence of the `after` string. + + If used with `remove_rules`, then remove the first occurrence of `remove_rules` + + after the first occurrence of the `after` string. The `remove_rules` + will be + + processed before the `add_rules`. + + ' + type: string + remove_rules: + description: 'The rules which will be removed from the existing NFS export + rules for the + + file system. Only the first occurrence of the `remove_rules` will be + removed. + + If `export_policy` is in use and and this field is set, the operation + will fail. + + ' + type: string + _smb: + type: object + properties: + client_policy: + description: 'Deprecated. See File System Exports for newer functionality. + + The value returned will be the `client_policy` of the File System + + Export for the default server, and SMB, with the `export_name` + + matching the file system name, if there is one and null otherwise. + + Modifying this field will still work. + + If the current value is null, then setting this field will attempt + + to create a File System Export with the `client_policy` + + and other default values. The `export_name` will be the same as the + + file system''s `name`. + + If the current value is not null, then setting this field will change + + the `client_policy` in the matching File System Export. + + The SMB Client policy for the file system. Setting a policy here grants + + access permissions (e.g. read-only or read-write) to the file system via + + SMB on a per-client basis. + + If no policy is set here, no client will have access. + + Use "" to clear. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + continuous_availability_enabled: + description: 'If set to `true`, the file system will be continuously available + during + + disruptive scenarios such as network disruption, blades failover, etc. + + If not specified, defaults to `true`. + + ' + type: boolean + enabled: + description: 'If set to `true`, enables access to the file system over the + SMB + + protocol. If not specified, defaults to `false`. + + ' + type: boolean + share_policy: + description: 'Deprecated. See File System Exports for newer functionality. + + The value returned will be the `policy` of the File System + + Export for the default server, and SMB, with the `export_name` + + matching the file system name, if there is one and null otherwise. + + Modifying this field will still work. + + If the current value is null, then setting this field will attempt + + to create a File System Export with the policy + + and other default values. The `export_name` will be the same as the + + file system''s `name`. + + If the current value is not null, then setting this field will change + + the `policy` in the matching File System Export. + + The SMB Share policy for the file system. Setting a policy here + + grants access permissions (e.g. allow or deny Full Control, Change, + + and/or Read) to the file system via SMB on a per-user / per-group basis. + + If no policy is set here, no user or group will have access. + + Use "" to clear. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _fixedLocationReference: + allOf: + - $ref: '#/components/schemas/_fixedReference' + - type: object + properties: + display_name: + description: 'Full name of the source with remote array information. + + Response will be same as source name for local file systems and policies. + + ' + type: string + readOnly: true + example: irp624-c02:fs1 + is_local: + description: 'Is the location reference to the local array or somewhere + remote? + + ' + type: boolean + readOnly: true + location: + description: 'A reference to the location where the object is defined. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + FileSystem: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + created: + description: Creation timestamp of the file system. + type: integer + format: int64 + readOnly: true + default_group_quota: + description: The default space quota for a group writing to this file + system. + type: integer + format: int64 + default_user_quota: + description: The default space quota for a user writing to this file system. + type: integer + format: int64 + destroyed: + description: 'Returns a value of `true` if the file system has been destroyed + and is pending eradication. + + The file system cannot be modified while it is in the destroyed state. + + The `time_remaining` value displays the amount of time left until the + destroyed + + file system is permanently eradicated. Once eradication has begun, the + file system can no + + longer be recovered. Before the `time_remaining` period has elapsed, + + the destroyed file system can be recovered through the PATCH method + + by setting `destroyed=false`. + + ' + type: boolean + eradication_config: + $ref: '#/components/schemas/_fileSystemEradicationConfig' + fast_remove_directory_enabled: + description: 'If set to `true`, the file system, when mounted, will contain + a + + directory that can be used for fast removal of other directories. + + Directories can be moved into the fast remove directory in order + + to have them deleted, and their space freed, more quickly than a + + normal removal operation. + + ' + type: boolean + group_ownership: + description: 'The group ownership for new files and directories in a file + system. + + Possible values are `creator` and `parent-directory`. + + If `creator` is selected, the owning group of new files and directories + + is the primary group of the user who creates them. + + If `parent-directory` is selected, the owning group is the parent + + directory group. + + Note: Existing files and directories are unaffected by this change. + + ' + type: string + hard_limit_enabled: + description: 'If set to `true`, the file system''s size, as defined by + `provisioned`, + + is used as a hard limit quota. + + ' + type: boolean + http: + description: HTTP configuration. + title: Http + allOf: + - $ref: '#/components/schemas/_http' + multi_protocol: + description: Multi-protocol configuration. + title: MultiProtocol + allOf: + - $ref: '#/components/schemas/_multiProtocol' + nfs: + description: NFS configuration. + title: Nfs + allOf: + - $ref: '#/components/schemas/_nfs' + node_group: + description: 'The nodes contains the data of the file system. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + promotion_status: + description: 'Possible values are `promoted` and `demoted`. + + The current status of the file system with respect to replication. Changes + via + + `requested_promotion_state`. The default for new file systems is + + `promoted`. + + ' + type: string + readOnly: true + provisioned: + description: 'The provisioned size of the file system, displayed in bytes. + If set to an + + empty string (`""`), the file system is unlimited in size. + + ' + type: integer + format: int64 + example: 1048576 + qos_policy: + description: 'The QoS policy for the File System defines the performance + controls + + that can be applied to the aggregate performance of all the clients + + accessing the file system. + + If no policy is configured for a file system, then no performance + + controls are applied to it. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + realms: + description: 'The realms containing this file system. + + ' + type: array + items: + $ref: '#/components/schemas/_fixedReference' + readOnly: true + requested_promotion_state: + description: 'Possible values are `promoted` and `demoted`. + + The `demoted` state is used for replication targets and is only allowed + to be set + + if the file system is in a replica-link relationship. The additional + + query param `discard-non-snapshotted-data` must be set to `true` + + when demoting a file system. The default for new file systems is + + `promoted`. + + ' + type: string + smb: + description: SMB configuration. + title: Smb + allOf: + - $ref: '#/components/schemas/_smb' + snapshot_directory_enabled: + description: 'If set to `true`, a hidden .snapshot directory will be present + in each + + directory of the file system when it is mounted. + + The .snapshot directory allows clients read access to the contents of + + the snapshots that have been taken of a directory. + + If set to `false`, the .snapshot directory will not be present in any + + directories within a mounted file system. + + ' + type: boolean + source: + description: A reference to the source file system. + title: LocationReference + allOf: + - $ref: '#/components/schemas/_locationReference' + space: + description: The space usage of the file system. + title: Space + allOf: + - $ref: '#/components/schemas/_space' + storage_class: + $ref: '#/components/schemas/StorageClassInfo' + time_remaining: + description: 'Time in milliseconds before the file system is eradicated. + + `null` if not destroyed. + + ' + type: integer + format: int64 + readOnly: true + workload: + $ref: '#/components/schemas/_workloadConfigurationReference' + writable: + description: 'Whether the file system is writable or not. If `false`, + this overrides + + any protocol or file permission settings and prevents changes. If `true`, + then + + the protocol and file permission settings are evaluated. + + If not specified, defaults to `true`. Modifiable. + + ' + type: boolean + FileSystemGroupPerformance: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + bytes_per_op: + description: 'Average operation size (read bytes+write bytes/read ops+write + ops). + + ' + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + file_system: + description: The file system on which the performance was measured. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + group: + description: The group whose performance is represented. + title: Group + allOf: + - $ref: '#/components/schemas/_group' + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + FileSystemPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + bytes_per_op: + description: 'Average operation size (read bytes+write bytes/read ops+write + ops). + + ' + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + FileSystemUserPerformance: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + bytes_per_op: + description: 'Average operation size (read bytes+write bytes/read ops+write + ops). + + ' + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_read: + description: Average read size in bytes per read operation. + type: number + format: double + minimum: 0 + readOnly: true + bytes_per_write: + description: Average write size in bytes per write operation. + type: number + format: double + minimum: 0 + readOnly: true + file_system: + description: The file system on which the performance was measured. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + others_per_sec: + description: Other operations processed per second. + type: number + format: double + minimum: 0 + readOnly: true + read_bytes_per_sec: + description: Bytes read per second. + type: number + format: double + minimum: 0 + readOnly: true + reads_per_sec: + description: Read requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + usec_per_other_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + other operations. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_read_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a read request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + usec_per_write_op: + description: 'Average time, measured in microseconds, it takes the array + to process + + a write request. + + ' + type: number + format: double + minimum: 0 + readOnly: true + user: + description: The user whose performance is represented. + title: User + allOf: + - $ref: '#/components/schemas/_user' + write_bytes_per_sec: + description: Bytes written per second. + type: number + format: double + minimum: 0 + readOnly: true + writes_per_sec: + description: Write requests processed per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + WormDataPoliciesMembersResponse: + type: object + properties: + items: + description: A list of members for worm data policies. + type: array + items: + $ref: '#/components/schemas/PolicyMemberContext' + _fileSystemExportBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + enabled: + description: 'Returns a value of `true` if and only if the export policy + that manages this + + export is enabled AND the protocol is enabled on the file system. + + ' + type: boolean + readOnly: true + export_name: + description: 'The name of the export used by clients to mount the file + system. + + Export names must be unique within the same protocol/server combination. + + ' + type: string + member: + description: Reference to the file system the policy is applied to. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy: + description: Reference to the NFS export policy or SMB client policy. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + policy_type: + description: 'Policy type attached to the export. It is either SMB or + NFS. + + ' + type: string + readOnly: true + server: + description: Reference to the server the export will be visible on. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + share_policy: + description: Reference to the SMB share policy (only used for SMB). + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + status: + description: 'Explains why `enabled` is `false`. Valid values include + `policy_disabled` + + and `protocol_disabled`. + + ' + type: string + readOnly: true + FileSystemExport: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_fileSystemExportBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + workload: + $ref: '#/components/schemas/_workloadConfigurationFixedReference' + _fixedReferenceNoResourceType: + type: object + properties: + id: + description: 'A non-modifiable, globally unique ID chosen by the system. + + ' + type: string + readOnly: true + name: + type: string + readOnly: true + x-readOnly: true + _locationReference: + allOf: + - $ref: '#/components/schemas/_reference' + - type: object + properties: + display_name: + description: 'Full name of the source with remote array information. + + Response will be same as source name for local file systems and policies. + + ' + type: string + readOnly: true + example: irp624-c02:fs1 + is_local: + description: 'Is the location reference to the local array or somewhere + remote? + + ' + type: boolean + readOnly: true + location: + description: 'A reference to the location where the object is defined. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + PolicyMemberWithRemote: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/PolicyFileSystemSnapshot' + - type: object + properties: + link: + description: 'Only populated if the `member` is a file system replica + link. Contains additional + + information about the link. + + ' + title: MemberLink + allOf: + - $ref: '#/components/schemas/_memberLink' + FileSystemSnapshotTransferResponse: + type: object + properties: + items: + description: A list of file system snapshot objects. + type: array + items: + $ref: '#/components/schemas/FileSystemSnapshotTransfer' + FileSystemSnapshotTransfer: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + completed: + description: 'A timestamp at which the replication of the snapshot completed. + + ' + type: integer + format: int64 + readOnly: true + data_transferred: + description: The amount of data transferred to the target, in bytes. + type: integer + format: int64 + readOnly: true + direction: + $ref: '#/components/schemas/_direction' + local_snapshot: + description: 'A reference to the associated local file system snapshot. + + ' + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + progress: + description: 'A percentage that indicates + + how much progress has been made on the transfer. + + ' + type: number + format: double + minimum: 0 + maximum: 1 + readOnly: true + remote: + description: 'The array where the remote file system snapshot is located. + + ' + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + remote_snapshot: + description: 'A reference to the associated remote file system snapshot. + + ' + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + started: + description: 'A timestamp at which the replication of the snapshot started. + + ' + type: integer + format: int64 + readOnly: true + status: + description: 'The status of current replication. + + Valid values are `completed`, `in-progress`, and `queued`. + + ' + type: string + readOnly: true + PolicyFileSystemSnapshotResponse: + type: object + properties: + items: + description: A list of members for policies. + type: array + items: + $ref: '#/components/schemas/PolicyFileSystemSnapshot' + FileLockResponse: + type: object + properties: + items: + description: A list of file locks. + type: array + items: + $ref: '#/components/schemas/FileLock' + FileSystemClientsResponse: + type: object + properties: + items: + description: A list of file system clients. + type: array + items: + $ref: '#/components/schemas/FileSystemClient' + FileSystemLockNlmReclamation: + 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 + FileSessionResponse: + type: object + properties: + items: + description: A list of file sessions. + type: array + items: + $ref: '#/components/schemas/FileSession' + FileSystemStorageClassSpace: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + space: + $ref: '#/components/schemas/_space' + storage_class: + description: The storage class type of the space information, either `S500X-S` + (speed) or `S500X-A` (archival). + type: string + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + FileSystemOpenFilesResponse: + type: object + properties: + items: + description: A list of file system open file objects. + type: array + items: + $ref: '#/components/schemas/FileSystemOpenFile' + _newName: + type: object + properties: + name: + description: The new name for the resource. + type: string + 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/_fleetMemberPostMembersMember' + FleetMember: + type: object + properties: + coordinator_of: + description: 'List of array groups that the member is the coordinator of. + + ' + type: array + items: + $ref: '#/components/schemas/_fixedReference' + fleet: + $ref: '#/components/schemas/_fixedReferenceWithIsLocal' + member: + $ref: '#/components/schemas/_fixedReferenceWithIsLocal' + 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 + HardwareTemperatures: + description: 'Provides detailed information about temperature readings from + a sensor, + + including its status and threshold limits. + + ' + type: object + properties: + name: + description: The name of the temperature sensor. + type: string + readOnly: true + reading: + description: The latest temperature measurement reported by the sensor. + type: number + format: double + readOnly: true + status: + description: 'The current operational state of the sensor, + + indicating whether it is functioning normally or experiencing issues. + + Possible values include HEALTHY, NON_CRITICAL, CRITICAL, UNRECOVERABLE, + UNKNOWN. + + ' + type: string + readOnly: true + thresholds: + $ref: '#/components/schemas/HardwareTemperaturesThresholds' + HardwareConnectorPerformance: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + link_aggregation_group: + description: The link aggregation group which this entity belongs to. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + other_errors_per_sec: + description: 'The sum of unspecified reception and transmission errors + per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + received_bytes_per_sec: + description: 'Bytes received per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + received_crc_errors_per_sec: + description: 'Reception CRC errors per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + received_frame_errors_per_sec: + description: 'Received packet frame errors per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + received_packets_per_sec: + description: 'Packets received per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + time: + description: 'Sample time in milliseconds since UNIX epoch. + + ' + type: integer + format: int64 + readOnly: true + total_errors_per_sec: + description: 'The sum of all reception and transmission errors per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + transmitted_bytes_per_sec: + description: 'Bytes transmitted per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + transmitted_carrier_errors_per_sec: + description: 'Transmission carrier errors per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + transmitted_dropped_errors_per_sec: + description: 'Transmitted packets dropped per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + transmitted_packets_per_sec: + description: 'Packets transmitted per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + x-readOnly: true + Keytab: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + encryption_type: + description: 'The encryption type used by the Kerberos key distribution + center to + + generate the keytab. + + ' + type: string + readOnly: true + example: aes256-cts-hmac-sha1-96 + fqdn: + description: 'The fully qualified domain name to which the keytab was + issued. + + ' + type: string + readOnly: true + example: vip1.my-array.customerdomain.example.com + kvno: + description: 'The key version number of the key used to generate the keytab. + + ' + type: integer + format: int64 + readOnly: true + example: 1 + prefix: + description: 'The prefix in the name of the keytab object. This is the + same for + + all keytab objects created from a single keytab file. The name of + + a keytab entry is created in the format `.` for all + + entries. + + ' + type: string + readOnly: true + example: auth-keytabs + principal: + description: The service name for which the keytab was issued. + type: string + readOnly: true + example: nfs + realm: + description: The Kerberos realm that issued the keytab. + type: string + readOnly: true + example: my-secure-realm.com + server: + description: 'The server where the keytab is used. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + source: + description: 'A reference to the Active Directory configuration for the + computer account + + that was used to create this keytab. If this keytab was uploaded from + a + + file, all fields in the reference possess `null` values. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + suffix: + description: 'The suffix in the name of the keytab object, determined + at creation + + time using the slot number of the keytab entry in a file and the + + number of existing entries with the same prefix. The name of a + + keytab entry is created in the format `.` for all + + entries. + + ' + type: integer + format: int64 + readOnly: true + example: 4 + LegalHoldHeldEntity: + type: object + properties: + file_system: + description: Reference to the file system that the legal hold is applied + to. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + legal_hold: + description: Reference to the legal hold. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + path: + description: The path of the file or directory being held. + type: string + status: + description: 'The status of the legal hold with respect to the held entity. + + Valid values include: + + `applied` for holds that are actively applied, + + `applying` for holds that are being recursively applied but have not yet + completed, + + `releasing` for holds that are being released recursively but have not + yet completed. + + Entities that are releasing will no longer be held once this operation + completes. + + ' + type: string + _lifecycleRuleConfigExtension: + 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 + LifecycleRule: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/_lifecycleRuleConfigExtension' + - type: object + properties: + bucket: + description: 'The bucket which this lifecycle rule is targeting. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + 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 + keep_previous_version_for: + description: 'Time after which previous 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 + prefix: + description: 'Object key prefix identifying one or more objects in the + bucket. + + Can have a maximum length of 1024 characters. + + ' + type: string + rule_id: + description: 'Unique identifier for the rule. + + Can have a maximum length of 255 characters. + + ' + type: string + FileInfo: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + length: + description: 'Length of the file (in bytes). + + ' + type: integer + readOnly: true + _auditLogNamePrefix: + type: object + properties: + prefix: + description: 'Prefix for the audit log object name. + + ' + type: string + example: s3auditlog + _auditLogRotate: + type: object + properties: + duration: + description: 'Time after which audit log objects will be rotated. + + Measured in milliseconds. + + Multiples of 60000 are supported. + + ' + type: integer + format: int64 + minimum: 300000 + maximum: 86400000 + example: 300000 + LogTargetsObjectStoreWithContext: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/LogTargetsObjectStore' + MaintenanceWindow: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: 'The period of time during which maintenance occurs. + + Many 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 + ManagementAccessPolicyRuleInPolicy: + allOf: + - $ref: '#/components/schemas/ManagementAccessPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + _version: + type: object + properties: + version: + description: 'A hash of the other properties of this resource. This can + be used when + + updating the resource to ensure there aren''t any updates since the + + resource was read. + + ' + type: string + readOnly: true + ManagementAuthenticationPolicyConfig: + allOf: + - type: object + description: 'The authentication configuration for a specific interface (e.g., + ssh). Two types of + + configurations are supported: `allowed_methods` and `required_methods`, + but only one of them can + + be set to a non-empty list. + + If `allowed_methods` is set, admins can authenticate using any of the methods + in the list via + + the interface. + + If `required_methods` is set, admins must authenticate using all of the + methods in the list via + + the interface. + + ' + properties: + allowed_methods: + description: 'The authentication methods that are allowed for this interface. + It cannot contain + + duplicates. + + ' + type: array + maxItems: 10 + items: + $ref: '#/components/schemas/ManagementAuthenticationPolicyConfigMethod' + required_methods: + description: 'The authentication methods that are required for this interface. + It cannot contain + + duplicates. `default` is not allowed as a required method. + + ' + type: array + maxItems: 10 + items: + $ref: '#/components/schemas/ManagementAuthenticationPolicyConfigMethod' + PolicyBaseContext: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + NetworkAccessPolicyRuleInPolicy: + allOf: + - $ref: '#/components/schemas/NetworkAccessPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + NetworkAccessPolicyRulePostBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + client: + description: 'Specifies the clients that will be permitted or denied access + to the interface. + + Accepted notations include a single IP address, subnet in CIDR notation, + + or all clients (specified as `*`). + + The default value is `*` if not specified. + + ' + type: string + example: 1.2.3.4 + effect: + description: 'If set to `allow`, the specified client will be permitted + to access the specified + + interfaces. If set to `deny`, the specified client will be denied access + to them. + + Valid values include `allow` and `deny`. + + The default value is `allow` if not specified. + + ' + type: string + interfaces: + description: 'Specifies which product interfaces this rule applies to, + whether it is + + permitting or denying access. Valid values include `management-ssh`, + + `management-rest-api`, `management-web-ui`, `snmp`, and + + `local-network-superuser-password-access`. + + ' + type: array + maxItems: 5 + items: + type: string + _policyRuleIndex: + type: object + properties: + index: + description: 'The index within the policy. The `index` indicates the order + the rules are evaluated. + + NOTE: It is recommended to use the query param `before_rule_id` to do + reordering to + + avoid concurrency issues, but changing `index` is also supported. `index` + can not be + + changed if `before_rule_id` or `before_rule_name` are specified. + + ' + type: integer + format: int32 + NetworkAccessPolicyRuleBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + client: + description: 'Specifies the clients that will be permitted or denied access + to the interface. + + Accepted notations include a single IP address, subnet in CIDR notation, + + or all clients (specified as `*`). + + The default value is `*` if not specified. + + ' + type: string + example: 1.2.3.4 + effect: + description: 'If set to `allow`, the specified client will be permitted + to access the specified + + interfaces. If set to `deny`, the specified client will be denied access + to them. + + Valid values include `allow` and `deny`. + + ' + type: string + interfaces: + description: 'Specifies which product interfaces this rule applies to, + whether it is + + permitting or denying access. Valid values include `management-ssh`, + + `management-rest-api`, `management-web-ui`, `snmp`, and + + `local-network-superuser-password-access`. + + ' + type: array + maxItems: 5 + items: + type: string + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy_version: + description: 'The policy''s version. This can be used when updating the + + resource to ensure there aren''t any updates to the policy since the + resource was read. + + ' + type: string + readOnly: true + _referenceWithoutType: + type: object + properties: + id: + description: 'A globally unique, system-generated ID. + + The ID cannot be modified. + + ' + type: string + name: + description: 'The resource name, such as volume name, pod name, + + snapshot name, and so on. + + ' + type: string + NetworkInterfacePingResponse: + type: object + properties: + items: + description: A list of network ping run result. + type: array + items: + $ref: '#/components/schemas/NetworkInterfacePing' + NetworkInterfaceTraceResponse: + type: object + properties: + items: + description: A list of network trace run result. + type: array + items: + $ref: '#/components/schemas/NetworkInterfaceTrace' + NetworkInterfacesConnectorsPerformance: + allOf: + - $ref: '#/components/schemas/HardwareConnectorPerformance' + - 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 + readOnly: true + flow_control_received_discarded_packets_per_sec: + description: 'Number of received packets that were physically discarded + + per second due to errors or other reasons. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + flow_control_received_lossless_bytes_per_sec: + description: 'Bytes received per second with lossless flow control settings. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + flow_control_received_pause_frames_per_sec: + description: 'Received pause frames per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + flow_control_transmitted_congestion_packets_per_sec: + description: 'Number of congestion control packets transmitted per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + 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 + readOnly: true + flow_control_transmitted_lossless_bytes_per_sec: + description: 'Bytes transmitted per second with lossless flow control + settings. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + flow_control_transmitted_pause_frames_per_sec: + description: 'Transmitted pause frames per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + 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 + readOnly: true + rdma_received_sequence_errors_per_sec: + description: 'The number of received RDMA packet sequence errors per second. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + 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 + readOnly: true + x-readOnly: true + NetworkInterfacesConnectorsSetting: + description: The global network setting for all network connectors. + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + roce: + description: 'RoCE(RDMA over Converged Ethernet) configuration for network + connectors. + + ' + title: NetworkInterfacesConnectorsSettingRoce + allOf: + - $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingRoce' + NetworkConnectionStatisticsResponse: + type: object + properties: + items: + description: 'A list of network connection statistics + + ' + type: array + items: + $ref: '#/components/schemas/NetworkConnectionStatistics' + NetworkInterfaceNeighborResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/NetworkInterfaceNeighbor' + description: 'A list of network LLDP neighbors + + ' + NfsExportPolicyRuleInPolicy: + allOf: + - $ref: '#/components/schemas/NfsExportPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + NfsExportPolicyPatchRuleInPolicy: + allOf: + - $ref: '#/components/schemas/NfsExportPolicyRuleBasePatchRequest' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + NfsExportPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - $ref: '#/components/schemas/_context' + - type: object + properties: + rules: + description: 'All of the rules that are part of this policy. The order + is the evaluation order. + + ' + type: array + items: + $ref: '#/components/schemas/NfsExportPolicyRuleInPolicy' + workload: + $ref: '#/components/schemas/_workloadConfigurationFixedReference' + NfsExportPolicyRuleBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + access: + description: 'Specifies access control for the export. Valid values are + `root-squash`, `all-squash`, and + + `no-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-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 + 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. + + ' + type: integer + format: int64 + minimum: 0 + 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: integer + format: int64 + minimum: 0 + example: 65530 + atime: + description: 'If `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 `false`, disables the update of inode access times after read operations. + + Defaults to `true`. + + ' + type: boolean + 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. + + ' + type: string + fileid_32bit: + description: 'Whether the file id is 32 bits or not. Defaults to `false`. + + ' + type: boolean + 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. + + ' + type: string + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy_version: + description: 'The policy''s version. This can be used when updating the + + resource to ensure there aren''t any updates to the policy since the + resource was read. + + ' + type: string + readOnly: true + required_transport_security: + description: 'Specifies the minimum transport security required for clients + to access the export. + + If `tls` is set, then all clients must use TLS or their attempts to + mount will be rejected, + + and further use of client certificate authentication is optional. + + If `mutual-tls` is set, then all clients must use TLS with client certificate + authentication + + or their attempts to mount will be rejected. + + If `none`, then no specific transport security mechanism is required + and any transport + + security mechanisms are permitted for use. + + If not specified when a rule is created, defaults to `none`. + + ' + type: string + example: tls + secure: + description: 'If `true`, prevents NFS access to client connections coming + from non-reserved ports. Applies + + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + + If `false`, allows NFS access to client connections coming from non-reserved + ports. Applies + + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + + The default is `false` if not specified. + + ' + type: boolean + security: + description: 'The security flavors to use for accessing files on this + mount point. If the server does not + + support the requested flavor, the mount operation fails. + + If `sys`, trusts the client to specify user''s identity. + + If `krb5`, provides cryptographic proof of a user''s identity 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 in order to + + enable Kerberos security. + + If `krb5i`, adds integrity checking to krb5, to ensure the data has + not been tampered with. + + If `krb5p`, adds integrity checking and encryption to krb5. This is + the most secure setting, + + but it also involves the most performance overhead. + + The default is `sys` if not specified. + + ' + type: array + items: + type: string + example: sys + NfsExportPolicyRuleBasePatchRequest: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + access: + description: 'Specifies access control for the export. Valid values are + `root-squash`, `all-squash`, and + + `no-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-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 + 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. + + ' + 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' + atime: + description: 'If `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 `false`, disables the update of inode access times after read operations. + + Defaults to `true`. + + ' + type: boolean + 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. + + ' + type: string + fileid_32bit: + description: 'Whether the file id is 32 bits or not. Defaults to `false`. + + ' + type: boolean + 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. + + ' + type: string + required_transport_security: + description: 'Specifies the minimum transport security required for clients + to access the export. + + If `tls` is set, then all clients must use TLS or their attempts to + mount will be rejected, + + and further use of client certificate authentication is optional. + + If `mutual-tls` is set, then all clients must use TLS with client certificate + authentication + + or their attempts to mount will be rejected. + + If `none`, then no specific transport security mechanism is required + and any transport + + security mechanisms are permitted for use. + + If not specified when a rule is created, defaults to `none`. + + ' + type: string + example: tls + secure: + description: 'If `true`, prevents NFS access to client connections coming + from non-reserved ports. Applies + + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + + If `false`, allows NFS access to client connections coming from non-reserved + ports. Applies + + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + + The default is `false` if not specified. + + ' + type: boolean + security: + description: 'The security flavors to use for accessing files on this + mount point. If the server does not + + support the requested flavor, the mount operation fails. + + If `sys`, trusts the client to specify user''s identity. + + If `krb5`, provides cryptographic proof of a user''s identity 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 in order to + + enable Kerberos security. + + If `krb5i`, adds integrity checking to krb5, to ensure the data has + not been tampered with. + + If `krb5p`, adds integrity checking and encryption to krb5. This is + the most secure setting, + + but it also involves the most performance overhead. + + The default is `sys` if not specified. + + ' + type: array + items: + type: string + example: sys + _referenceNameOnly: + type: object + properties: + name: + type: string + NodeGroup: + allOf: + - $ref: '#/components/schemas/_builtIn' + NodeGroupUse: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + use: + description: A reference to an object using this node group. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + _builtInNoId: + type: object + properties: + name: + description: Name of the object (e.g., a file system or snapshot). + type: string + readOnly: true + PolicyRuleObjectAccessBulkManage: + allOf: + - $ref: '#/components/schemas/PolicyRuleObjectAccessPost' + - type: object + properties: + name: + description: Name of the object (e.g., a file system or snapshot). + type: string + ObjectStoreAccessPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + account: + description: 'Reference of the associated account. If the policy is not + associated + + with an account, all fields in the reference possess `null` values. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + arn: + description: 'Amazon Resource Name of the policy. Used when referencing + the policy via + + S3 APIs. + + ' + type: string + readOnly: true + example: arn:aws:iam::myaccount:policy/mypolicy + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + description: + description: 'A description of the policy, optionally specified when the + policy is + + created. Cannot be modified for an existing policy. + + ' + type: string + readOnly: true + example: This policy allows users to list objects in production buckets. + enabled: + description: 'If `true`, the policy is enabled. If not specified, defaults + to `true`. + + ' + type: boolean + readOnly: true + rules: + type: array + items: + $ref: '#/components/schemas/PolicyRuleObjectAccess' + updated: + description: The last updated timestamp of the object. + type: integer + format: int64 + readOnly: true + _policyRuleObjectAccessCondition: + type: object + properties: + s3_delimiters: + description: 'If specified, groups result objects by the specified delimiter. + Only + + top-level groupings will be returned. + + Can be used with the `s3:ListBucket` and `s3:ListBucketVersions` actions. + + ' + type: array + items: + type: string + example: / + s3_prefixes: + description: 'If specified, restricts access and results based on the prefix + of the + + relevant objects. + + Can be used with the `s3:ListBucket` and `s3:ListBucketVersions` actions. + + ' + type: array + items: + type: string + example: home/ + source_ips: + description: 'If specified, the rule will apply only to requests matching + at least one + + provided IP address or subnet. + + Each entry must be in standard CIDR format (including an IP address + + without an associated routing prefix). + + Can be used with any action. + + ' + type: array + items: + type: string + example: + - 1.2.3.4 + - 5.6.7.0/24 + - 2001:DB8:1234:5678::/64 + PolicyRuleObjectAccess: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + actions: + description: 'The list of actions granted by this rule. Each included + action may + + restrict other properties of the rule. + + Supported actions are returned by the + + `/object-store-access-policy-actions` endpoint. + + ' + type: array + items: + type: string + example: + - s3:CreateBucket + - s3:PutObject + conditions: + description: 'Conditions used to limit the scope which this rule applies + to. + + ' + title: PolicyRuleObjectAccessCondition + allOf: + - $ref: '#/components/schemas/_policyRuleObjectAccessCondition' + 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: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + 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* + ObjectStoreAccessPolicyActionResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/ObjectStoreAccessPolicyAction' + _bucketDefaults: + type: object + properties: + hard_limit_enabled: + description: 'The value of this field will be used to configure the `hard_limit_enabled` + + field of newly created buckets associated with this object store account, + + if the bucket creation does not specify its own value. If not specified, + + defaults to `false`. + + ' + type: boolean + quota_limit: + description: 'The value of this field will be used to configure the `quota_limit` + field + + of newly created buckets associated with this object store account, if + the + + bucket creation does not specify its own value. If set to an empty string + + (`""`), the bucket default is unlimited in size. If not specified, + + defaults to unlimited. + + ' + type: string + _serverForAccountExport: + type: object + properties: + server: + description: 'The server to which the account will be exported. + + ' + title: ReferenceWithoutType + allOf: + - $ref: '#/components/schemas/_referenceWithoutType' + ObjectStoreAccount: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + bucket_defaults: + description: 'Default settings to be applied to newly created buckets + associated with + + this account. Values here will be used in bucket creation requests which + + do not specify their own values for corresponding fields. + + ' + title: BucketDefaultsReadonly + allOf: + - $ref: '#/components/schemas/_bucketDefaultsReadonly' + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + hard_limit_enabled: + description: 'If set to `true`, the account''s size, as defined by `quota_limit`, + + is used as a hard limit quota. + + If set to `false`, a hard limit quota will not be applied to the + + account, but soft quota alerts will still be sent if the account has + + a value set for `quota_limit`. + + ' + type: boolean + object_count: + description: The count of objects within the account. + type: integer + format: int64 + readOnly: true + public_access_config: + $ref: '#/components/schemas/_publicAccessConfig' + quota_limit: + description: 'The effective quota limit applied against the size of the + account, displayed in bytes. + + If unset, the account is unlimited in size. + + ' + type: integer + realms: + description: 'The realms containing this account. + + ' + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + space: + description: The space specification of the object store account. + title: Space + allOf: + - $ref: '#/components/schemas/_space' + ObjectStoreAccountExport: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + enabled: + description: 'Returns a value of `true` if the account export is enabled. + + If not specified, defauts to `true`. + + ' + type: boolean + example: true + member: + description: 'References the account which will be exported. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy: + description: 'References the s3 export policy that is used for the export. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + realms: + description: 'A list of realms containing the export. + + ' + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + server: + description: 'The server to which the account will be exported. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + ObjectStoreTrustPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + enabled: + description: 'If `true`, the policy is enabled. If not specified, defaults + to `true`. + + ' + type: boolean + readOnly: true + role: + description: Object Store Role to which the Trust Policy applies. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + rules: + description: List of rules establishing the trust policy + type: array + items: + $ref: '#/components/schemas/TrustPolicyRule' + _trustPolicyRuleCondition: + description: 'Identity-provider-specific condition that specifies who can assume + the role. + + ' + type: object + properties: + key: + description: 'Key from the context of the role assuming request that will + have its + + value compared based on the operator specified in this condition to the + + values provided in this condition. + + ' + type: string + example: saml:sub + operator: + description: 'Operator specifying the comparison to be done between the + values from + + the request context and the values provided in this condition. + + Valid values: `StringEquals`. + + ' + type: string + example: StringEquals + values: + description: 'Values to be compared with the values in the role assuming + request + + context identified by the key. If multiple values are specified, it''s + + sufficient if just one matches. + + ' + type: array + items: + type: string + example: + - something + - anything + TrustPolicyRuleWithContext: + allOf: + - $ref: '#/components/schemas/TrustPolicyRule' + - $ref: '#/components/schemas/_context' + ObjectStoreUser: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/_context' + - type: object + properties: + access_keys: + description: References of the user's access keys. + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + account: + description: Reference of the associated account. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + created: + description: Creation timestamp of the object. + type: integer + format: int64 + readOnly: true + _policy_rule: + description: Rule + type: object + properties: + at: + description: 'Time during the day to take the snapshot (using array time + zone), + + only valid if ''every'' is in days. + + ' + type: integer + format: int64 + every: + description: How often to take snapshots. + type: integer + format: int64 + keep_for: + description: The time to keep the snapshots for. + type: integer + format: int64 + time_zone: + description: The time zone to use with the `at` time. + type: string + example: America/Los_Angeles + SnapshotWormDataPolicyBase: + allOf: + - $ref: '#/components/schemas/_resourceFixed' + - $ref: '#/components/schemas/_realmsReference' + - type: object + properties: + enabled: + description: 'If `true`, the policy is enabled. If not specified, defaults + to `true`. + + ' + type: boolean + is_local: + description: Whether the policy is defined on the local array. + type: boolean + readOnly: true + location: + description: Reference to the array where the policy is defined. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy_type: + description: 'Type of the policy. Valid values include `snapshot` and + `worm-data`. + + ' + type: string + readOnly: true + Policy: + allOf: + - $ref: '#/components/schemas/PolicyBase' + - $ref: '#/components/schemas/_context' + - type: object + properties: + retention_lock: + description: 'If retention lock is locked, then the the policy can not + be removed + + from the associated file systems and the rules may not be changed. + + Valid values are `locked` and `unlocked`. + + Contact Pure Technical Services to change `locked` to `unlocked`. + + ' + type: string + readOnly: true + rules: + type: array + items: + $ref: '#/components/schemas/_policy_rule' + workload: + $ref: '#/components/schemas/_workloadConfigurationFixedReference' + PolicyBaseResponse: + type: object + properties: + items: + description: A list of basic policy objects. + type: array + items: + $ref: '#/components/schemas/PolicyBaseContext' + PublicKey: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/PublicKeyPost' + - type: object + properties: + algorithm: + description: 'The cryptographic algorithm used by the key. + + Valid values include `rsa`, `rsassa-pss`, `dsa`, `ec`, and `ed25519`. + + ' + type: string + readOnly: true + example: rsa + key_size: + description: The size of the public key in bits. + type: integer + format: int32 + readOnly: true + example: 2048 + PublicKeyUseResponse: + type: object + properties: + items: + description: A list of public key use objects. + type: array + items: + $ref: '#/components/schemas/PublicKeyUse' + GroupQuota: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + file_system: + $ref: '#/components/schemas/_fixedReference' + file_system_default_quota: + description: 'File system''s default group quota (in bytes). If it is + `0`, it means + + there is no default quota. This will be the effective group quota if + + the group doesn''t have an individual quota. This default quota is set + + through the `file-systems` endpoint. + + ' + type: integer + format: int64 + readOnly: true + group: + description: The group on which this quota is enforced. + title: Group + allOf: + - $ref: '#/components/schemas/_group' + quota: + description: 'The space limit of the quota (in bytes) for the specified + group, cannot + + be `0`. If specified, this value will override the file system''s default + + group quota. + + ' + type: integer + format: int64 + usage: + description: 'The usage of the file system (in bytes) by the specified + group. + + ' + type: integer + format: int64 + readOnly: true + UserQuota: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + file_system: + $ref: '#/components/schemas/_fixedReference' + file_system_default_quota: + description: 'File system''s default user quota (in bytes). If it is `0`, + it means there + + is no default quota. This will be the effective user quota if the user + + doesn''t have an individual quota. This default quota is set through + the + + `file-systems` endpoint. + + ' + type: integer + format: int64 + readOnly: true + quota: + description: 'The limit of the quota (in bytes) for the specified user, + cannot be `0`. + + If specified, this value will override the file system''s default user + + quota. + + ' + type: integer + format: int64 + usage: + description: 'The usage of the file system (in bytes) by the specified + user. + + ' + type: integer + format: int64 + readOnly: true + user: + description: The user on which this quota is enforced. + title: User + allOf: + - $ref: '#/components/schemas/_user' + _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: 'NFS, SMB, and SMB share policy configuration to be 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 that can be applied 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 + Realm: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + created: + description: Creation timestamp of the realm. + type: integer + format: int64 + readOnly: true + default_inbound_tls_policy: + description: 'The default TLS policy governing inbound traffic from clients + accessing the accessing the realm''s + + network interfaces. This TLS policy will be applied for any IP addresses + within the realm that do not + + have a specific policy applied to them at a more granular level. If + no `default_inbound_tls_policy` + + is configured, then IP addresses within the realm that do not have a + specific policy + + applied to them at a more granular level will not be accessible using + TLS. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + 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 + + by setting `destroyed=false`. + + ' + type: boolean + space: + description: The space usage of the realm. + title: Space + allOf: + - $ref: '#/components/schemas/_space' + time_remaining: + description: 'Time in milliseconds before the realm is eradicated. + + `null` if not destroyed. + + ' + type: integer + format: int64 + readOnly: true + _objectStoreDefault: + type: object + description: Configuration of defaults for object store. + properties: + server: + description: 'Default server for new entities created in object store. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + RealmSpace: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + space: + $ref: '#/components/schemas/_space' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + RealmSpaceStorageClass: + allOf: + - $ref: '#/components/schemas/RealmSpace' + - properties: + storage_class: + description: The name of the storage-class. + type: string + RemoteArray: + allOf: + - $ref: '#/components/schemas/_resource' + - type: object + properties: + api_versions: + $ref: '#/components/schemas/_api_versions' + fleet: + $ref: '#/components/schemas/_fixedReferenceWithIsLocal' + 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: FlashBlade//S200 + 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: 4.4.99 + ResiliencyGroupResponse: + type: object + properties: + items: + description: 'A list of resiliency group objects. + + ' + type: array + items: + $ref: '#/components/schemas/ResiliencyGroup' + ResiliencyGroupMemberResponse: + type: object + properties: + items: + description: 'A list of resiliency group and member relationships. + + ' + type: array + items: + $ref: '#/components/schemas/Member' + PageInfoScale: + allOf: + - $ref: '#/components/schemas/PageInfo' + - type: object + properties: + more_items_remaining: + description: 'Returns a value of `true` if subsequent items can be retrieved. + + ' + type: boolean + example: false + ResourceAccess: + allOf: + - $ref: '#/components/schemas/_builtInRelationship' + - type: object + properties: + resource: + description: Resource to which the scope has access to. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + scope: + description: Scope which has access to the resource. + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + Role: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + permissions: + description: A list of permissions that the role can perform. + type: array + items: + $ref: '#/components/schemas/_permission' + _s3ExportPolicyRuleInlined: + allOf: + - $ref: '#/components/schemas/_referenceNameOnly' + - $ref: '#/components/schemas/S3ExportPolicyRulePost' + S3ExportPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseContext' + - type: object + properties: + rules: + type: array + items: + allOf: + - $ref: '#/components/schemas/_s3ExportPolicyRuleInlined' + - $ref: '#/components/schemas/_policyReference' + S3ExportPolicyRule: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/S3ExportPolicyRulePost' + - $ref: '#/components/schemas/_policyReference' + _oidcSsoPostIdp: + description: Identity Provider + type: object + properties: + provider_url: + description: 'URL of the Identity Provider server + + ' + type: string + provider_url_ca_certificate: + description: 'CA certificate used to validate the authenticity of the configured + + Identity Provider server. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + provider_url_ca_certificate_group: + description: 'A certificate group containing CA certificates that can be + used to + + validate the authenticity of the configured Identity Provider server. + + ' + title: Reference + allOf: + - $ref: '#/components/schemas/_reference' + OidcSso: + allOf: + - $ref: '#/components/schemas/_builtIn' + - $ref: '#/components/schemas/OidcSsoPost' + _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: https://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 + metadata_url_ca_certificate: + description: 'CA certificate used to validate the authenticity of the configured + + Identity Provider server. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + metadata_url_ca_certificate_group: + description: 'A certificate group containing CA certificates that can be + used to + + validate the authenticity of the configured Identity Provider server. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + 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 certificate used by the service provider to verify the + SAML response + + signature from the identity provider. The credential is managed by + + the `certificates` endpoint and `purecert` CLI commands. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _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 + readOnly: true + example: https://myarray.mycompany.com/login/saml2/sso/myidp + entity_id: + description: A globally unique name for the service provider. + type: string + readOnly: true + example: https://myarray.mycompany.com/saml2/service-provider-metadata/myidp + metadata_url: + description: The URL of the service provider metadata. + type: string + readOnly: true + example: https://myarray.mycompany.com/saml2/service-provider-metadata/myidp + TieringPolicyArchivalRule: + type: object + properties: + target_storage_class: + description: The storage class to which the data is moved. Will always be + `S500X-A` for archival rules. + type: string + example: S500X-A + readOnly: true + time: + description: The time at which this rule goes into effect, in milliseconds. + type: integer + format: int64 + example: 86400000 + type: + description: 'The type of the archival rule determining when to tier data + to the target storage class. + + Valid values are `LATEST_ACCESS` and `LATEST_MODIFICATION`. + + ' + type: string + example: LATEST_ACCESS + TieringPolicyRetrievalRule: + type: object + properties: + target_storage_class: + description: 'The storage class to which the data is moved. Will always + be `S500X-S` for retrieval rules. + + ' + type: string + example: S500X-S + readOnly: true + type: + description: 'The type of the retrieval rule determining criteria to tier + data to the target storage class. + + Valid values are `ON_READ` and `ONLY_ON_WRITE`. + + ' + type: string + example: ON_READ + StorageClassTieringPoliciesMembersResponse: + type: object + properties: + items: + description: A list of members for storage class tiering policies. + type: array + items: + $ref: '#/components/schemas/PolicyMember' + ServerResponseContext: + type: object + properties: + items: + description: A list of server objects. + type: array + items: + $ref: '#/components/schemas/ServerContext' + Server: + allOf: + - $ref: '#/components/schemas/_resource' + - $ref: '#/components/schemas/ServerPost' + - type: object + properties: + created: + description: Creation timestamp of the server. + type: integer + format: int64 + readOnly: true + directory_services: + description: 'The directory service config to be used by this server. + + ' + type: array + maxItems: 1 + readOnly: true + items: + $ref: '#/components/schemas/_reference' + realms: + description: 'The realms containing this server. + + ' + type: array + readOnly: true + items: + $ref: '#/components/schemas/_fixedReference' + Session: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: 'User session logs represent user login events performed in the + Purity//FB GUI, CLI, and + + REST API. + + ' + type: object + properties: + end_time: + description: 'Date and time the user logged out of the Purity//FB interface + in + + milliseconds since UNIX epoch. Set to 0 if the session is still active. + + ' + type: integer + format: int64 + readOnly: true + example: 1502234638 + event: + description: 'Description of session events. 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 + identifying_details: + description: 'Additional details, depending on the authentication method + used, + + which are necessary to uniquely identify who authenticated as + + a user. `null` if no additional details are needed. + + ' + type: string + readOnly: true + example: '''principal="john",serial=0001,key_id="arbitrary CA key id text",ssh_session_id=3233, + ca_key_fingerprint=UWRGBqyUXxTc5FKhUCw+/0tlwDXYPY1yLZk20zSCoDI''' + 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`, `password`, `ssh certificate`, + + and `public key`. + + ' + type: string + readOnly: true + example: public key + start_time: + description: 'Date and time the user logged in to the Purity//FB interface + + in milliseconds since UNIX epoch. + + ' + type: integer + format: int64 + readOnly: true + example: 1502234212 + user: + description: Username of the Purity//FB 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 + SmbClientPolicyRulePostInPolicy: + allOf: + - $ref: '#/components/schemas/SmbClientPolicyRulePostBase' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + SmbClientPolicyRuleInPolicy: + allOf: + - $ref: '#/components/schemas/SmbClientPolicyRuleBase' + - $ref: '#/components/schemas/_policyRuleIndexInPolicy' + SmbClientPolicy: + allOf: + - $ref: '#/components/schemas/PolicyBaseRenameable' + - $ref: '#/components/schemas/_version' + - $ref: '#/components/schemas/_context' + - 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 + rules: + description: 'All of the rules that are part of this policy. The order + is the + + evaluation order. + + ' + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbClientPolicyRuleInPolicy' + workload: + $ref: '#/components/schemas/_workloadConfigurationFixedReference' + SmbClientPolicyRulePostBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + client: + description: 'Specifies the clients that will be permitted to access the + export. + + Accepted notation is a single IP address, subnet in CIDR notation, + + or anonymous (`*`). + + The default is `*` if not specified. + + ' + type: string + example: 1.2.3.4 + 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`. + + ' + 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. + + ' + type: string + SmbClientPolicyRuleBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + client: + description: 'Specifies the clients that will be permitted to access the + export. + + Accepted notation is a single IP address, subnet in CIDR notation, + + or anonymous (`*`). + + ' + type: string + encryption: + description: 'Specifies whether the remote client is required to use SMB + encryption. Valid values are + + `required`, `disabled`, and `optional`. + + ' + type: string + example: optional + permission: + description: 'Specifies which read-write client access permissions are + allowed for the export. + + Valid values are `rw` and `ro`. + + ' + type: string + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + policy_version: + description: 'The policy''s version. This can be used when updating the + + resource to ensure there aren''t any updates to the policy since the + resource was read. + + ' + type: string + readOnly: true + SmbSharePolicy: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/PolicyBaseRenameable' + - type: object + properties: + rules: + description: 'All of the rules that are part of this policy. + + ' + type: array + maxItems: 200 + items: + $ref: '#/components/schemas/SmbSharePolicyRule' + workload: + description: 'A reference to the workload that is managing this policy. + + Set the `id` or `name` of the workload to an empty string to remove + the + + policy from the workload. + + The `name` and `configuration` may show as the string "(unknown)" briefly + after a failover. + + ' + title: WorkloadConfigurationFixedReference + allOf: + - $ref: '#/components/schemas/_workloadConfigurationFixedReference' + SmbSharePolicyRuleWithContext: + allOf: + - $ref: '#/components/schemas/SmbSharePolicyRule' + - $ref: '#/components/schemas/_context' + _snmp_v2c: + description: 'The v2c configurations of SNMP. + + ' + type: object + properties: + community: + description: 'Manager community ID under which Purity is to communicate + with + + the specified managers. + + ' + type: string + maxLength: 32 + example: '****' + _snmp_v3: + description: 'The v3 configurations of SNMP. + + ' + type: object + properties: + auth_passphrase: + description: 'Passphrase used by Purity 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 + + is to use in communications with them. + + ' + type: string + example: User1 + SnmpAgentMib: + type: object + properties: + mib: + description: MIB text. + type: string + readOnly: true + _snmp_v3_post: + description: 'The v3 configurations of SNMP. + + ' + type: object + properties: + auth_passphrase: + description: 'Passphrase used by Purity 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 + + is to use in communications with them. + + ' + type: string + example: User1 + _support_remote_assist_paths: + type: object + properties: + component_name: + description: The name of the FM. + type: string + status: + description: 'The status of the remote-assist session on the local FM. + + Valid values are `reconnecting`, `connected`, `disconnected`, + + and `unknown`. + + ' + type: string + example: connected + VerificationKey: + type: object + properties: + key_id: + description: 'The key id of the verification key. + + ' + type: integer + format: int64 + example: 1 + name: + description: 'Name of the verification key. Possible values include `access`. + + ' + type: string + verification_key: + description: The text of the verification key. + type: string + SupportDiagnosticsResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SupportDiagnostics' + SupportDiagnosticsDetailsResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SupportDiagnosticsDetails' + 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: + - 4.1.0 + - 4.1.1 + software_version: + description: 'The version of the software that the upgrade checks will + test. + + ' + type: string + example: 4.4.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 + SyslogServerPostOrPatch: + description: A syslog server + type: object + properties: + uri: + description: 'The URI of the syslog server in the format PROTOCOL://HOSTNAME:PORT. + + ' + type: string + example: tcp://my.syslogserver.com + SyslogServerContextResponse: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/SyslogServerContext' + SyslogServer: + allOf: + - $ref: '#/components/schemas/SyslogServerPost' + - $ref: '#/components/schemas/_resource' + TargetResponseContext: + type: object + properties: + items: + description: A list of target objects. + type: array + items: + $ref: '#/components/schemas/TargetWithContext' + ResourcePerformanceReplication: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + aggregate: + description: 'Total bytes transmitted or received per second for all types + of + + replication. + + ' + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + continuous: + description: 'Object backlog information and total bytes transmitted or + received + + per second for continuous replication. Continuous replication + + includes object replication. + + ' + title: ContinuousReplicationPerformance + allOf: + - $ref: '#/components/schemas/_continuousReplicationPerformance' + periodic: + description: 'Total bytes transmitted or received per second for periodic + + replication. Periodic replication includes file system replication, + + which is snapshot based. + + ' + title: Replication_performance + allOf: + - $ref: '#/components/schemas/_replication_performance' + time: + description: Sample time in milliseconds since UNIX epoch. + type: integer + format: int64 + readOnly: true + x-readOnly: true + _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' + _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 + 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. + + Specify targets as individual arrays (by setting `resource_type` to `remote-arrays`) + or as topology groups (by + + setting `resource_type` to `topology-groups/arrays`). + + Responses will have targets that are individual arrays. + + ' + type: array + items: + $ref: '#/components/schemas/_referenceWritable' + _workloadPlacementRecommendationParameter: + allOf: + - $ref: '#/components/schemas/_workloadParameter' + - description: 'A single parameter passed to recommendation API. It could specify + either a + + fixed value for the parameter or define constraints with a set of allowed + values. + + ' + type: object + properties: + constraints: + $ref: '#/components/schemas/_workloadPlacementRecommendationParameterConstraints' + _fixedReferenceWithoutType: + type: object + properties: + id: + description: 'A globally unique, system-generated ID. + + The ID cannot be modified. + + ' + type: string + readOnly: true + name: + description: 'The resource name, such as volume name, file system name, + + snapshot name, and so on. + + ' + type: string + readOnly: true + x-readOnly: true + _workloadPlacementRecommendationResult: + description: Single workload placement recommendation result. + type: object + properties: + parameters: + description: 'The parameter values to pass to the preset when creating the + workload based on this + + 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: 'List of all recommended arrays. + + ' + type: array + readOnly: true + items: + $ref: '#/components/schemas/_workloadPlacementRecommendationGenericTarget' + 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/_fixedReferenceWithoutType' + value: + description: 'Value of the tag. Supports up to 256 Unicode characters. + + ' + type: string + example: staging + _wormDataPolicyRetentionConfig: + type: object + properties: + default_retention: + description: 'Default retention period, in milliseconds. If the access time + is not specified + + when committing a file, then the default retention period is applied. + + ' + type: integer + format: int64 + max_retention: + description: 'Maximum retention period, in milliseconds. + + ' + type: integer + format: int64 + min_retention: + description: 'Minimum retention period, in milliseconds. + + ' + type: integer + format: int64 + mode: + description: 'The type of the retention lock. Valid values is `compliance`. + + ' + type: string + retention_lock: + description: 'If set to `locked`, then the value of retention attributes + or policy attributes are not + + allowed to change. + + If set to `unlocked`, then the value of the retention attributes and policy + attributes + + are allowed to change. + + Valid values are `unlocked` and `locked`. It is always allowed to change + from `unlocked` to + + `locked`. Contact Pure Technical Services to change from `locked` to `unlocked`. + + ' + type: string + example: unlocked + _errorContextResponseErrors: + type: object + properties: + context: + description: 'Contains information relating to the cause of this error, + + or the name of the object that was being processed when the error was + encountered. + + This may be `null` for more general errors. + + ' + type: string + location_context: + description: 'Contains information relating to the context in which the + request was executing + + when the error occurred. + + For example, this may be the name of an array in the same fleet. + + This may be `null` for more general errors, or if no explicit `context` + parameter + + was provided with the request. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + message: + description: A description of the error which occurred. + type: string + example: Resource does not exist. + _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 + _arrayEncryptionDataAtRest: + description: Data at Rest Encryption properties. + type: object + properties: + algorithms: + description: The algorithms used to encrypt data at rest on the array. + type: array + readOnly: true + items: + type: string + example: + - AES-256-GCM + enabled: + description: Returns a value of `true` if Data at Rest Encryption is enabled. + type: boolean + readOnly: true + entropy_source: + description: 'The entropy source used to generate the Data at Rest Encryption + key on the array. + + ' + type: string + readOnly: true + example: rdseed + x-readOnly: true + _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 + _replication_performance: + type: object + properties: + received_bytes_per_sec: + description: Total bytes received per second. + type: number + format: double + minimum: 0 + readOnly: true + transmitted_bytes_per_sec: + description: Total bytes transmitted per second. + type: number + format: double + minimum: 0 + readOnly: true + x-readOnly: true + _continuousReplicationPerformance: + allOf: + - $ref: '#/components/schemas/_replication_performance' + - type: object + properties: + object_backlog: + description: 'The total number of pending object operations + + and their size that are currently in the backlog. + + ' + title: ObjectBacklog + allOf: + - $ref: '#/components/schemas/_objectBacklog' + x-readOnly: true + _space: + type: object + properties: + available_provisioned: + description: 'The amount of space left that the current object can grow + before writes are stopped + + due to a hard limit quota being hit. This is total_provisioned minus the + virtual space + + used for file-systems and buckets. + + For array and object store accounts it is total_provisioned minus the + virtual space + + used by non-destroyed file-systems and buckets. + + ' + type: integer + format: int64 + minimum: 0 + example: 19937690345472 + available_ratio: + description: 'The ratio of the available space versus the total provisioned + space. + + ' + type: number + format: float + minimum: 0 + maximum: 1 + data_reduction: + description: Reduction of data. + type: number + format: float + readOnly: true + destroyed: + description: 'Unique physical space (excluding snapshots) occupied by destroyed + data within + + the child containers, in bytes. + + For buckets and filesystems, the destroyed space will be 0 as they cannot + have + + child containers. + + For the whole array, the space will be the sum of all destroyed buckets + and filesystems. + + ' + type: integer + format: int64 + readOnly: true + destroyed_virtual: + description: 'The amount of destroyed logically written data within the + child containers, in bytes. + + For buckets and filesystems, the destroyed virtual space will be 0 as + they cannot have + + child containers. + + For the whole array, the space will be the sum of all destroyed buckets + and filesystems. + + ' + type: integer + format: int64 + readOnly: true + shared: + description: 'The space contributed by data that is not unique to a managed + directory, + + or snapshot, measured in bytes. + + ' + type: integer + format: int64 + readOnly: true + snapshots: + description: Physical usage by snapshots, other than unique in bytes. + type: integer + format: int64 + readOnly: true + total_physical: + description: 'Deprecated. See total_used for the newer functionality. + + The total physical space consumed by the file system, measured in bytes. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + total_provisioned: + description: 'The effective provisioned size of the container, at which + a hard limit + + will be applied. + + For a bucket with a `quota_limit` value and `hard_limit_enabled` set to + `true`, + + this is its `quota_limit` value, unless the available space of the associated + + object store account, as defined by its `quota_limit` value, would prevent + the + + bucket from reaching its own `quota_limit` value. In such a case, + + `total_provisioned` will reflect the smaller value. + + For a file system with a `provisioned` value and `hard_limit_enabled` + set to + + `true`, this is the `provisioned` value of the file system. + + For an object store account with a `quota_limit` value and `hard_limit_enabled` + + set to `true`, this is the `quota_limit` value of the object store account. + + For the array, this is the sum of the file systems and accounts. + + Measured in bytes. + + ' + type: integer + format: int64 + minimum: 0 + example: 19937690345472 + total_used: + description: 'The total space consumed by customer data, measured in bytes. + + ' + type: integer + format: int64 + minimum: 0 + readOnly: true + unique: + description: 'Unique physical space occupied by customer data, in bytes. + + Excludes snapshots, destroyed. + + ' + type: integer + format: int64 + readOnly: true + virtual: + description: 'The amount of logically written data, in bytes. + + Excludes destroyed data. + + ' + type: integer + format: int64 + readOnly: true + example: 19937690345472 + _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 + + file system), or correspond to something in the environment, + + like a network interface. + + ' + type: object + properties: + name: + description: 'A name chosen by the user. Can be changed. Must be locally + unique. + + ' + type: string + Audit: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + arguments: + type: string + readOnly: true + command: + type: string + readOnly: true + ip_address: + type: string + readOnly: true + origin: + $ref: '#/components/schemas/_fixedReference' + scopes: + description: 'The realms and/or array which this audit affected and is + visible to. + + ' + type: array + items: + $ref: '#/components/schemas/_fixedReference' + subcommand: + type: string + readOnly: true + time: + type: integer + format: int64 + readOnly: true + user: + type: string + readOnly: true + user_agent: + type: string + readOnly: true + 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 + AuditFileSystemsPolicyRuleInPolicy: + allOf: + - $ref: '#/components/schemas/AuditFileSystemsPolicyRuleBase' + AuditFileSystemsPolicyOperation: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + description: + type: string + readOnly: true + description: 'A description of the operation. + + ' + example: Configures auditing on read, write of files in a file system. + BucketAuditFilterActionWithContext: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/BucketAuditFilterAction' + _objectLockConfigBase: + description: Configuration settings related to object lock. + type: object + properties: + default_retention_mode: + description: 'The retention mode used to apply locks on new objects if + + none is specified by the S3 client. + + Valid values include `compliance` and `governance`. + + If there is no default, this value is `null`. + + Use "" to clear. + + ' + type: string + example: governance + enabled: + description: 'If set to `true`, then S3 APIs relating to object lock + + may be used. + + ' + type: boolean + freeze_locked_objects: + description: 'If set to `true`, a locked object will be read-only and no + + new versions of the object may be created due to modifications. + + If not specified, defaults to `false`. + + ' + type: boolean + _objectLockConfigResponse: + allOf: + - $ref: '#/components/schemas/_objectLockConfigBase' + - type: object + properties: + default_retention: + description: 'The retention period, in milliseconds, used to apply locks + + on new objects if none is specified by the S3 client. + + Valid values are any multiple of `86400000` (1 day), up to + + `3153600000000` (36500 days). + + If there is no default, this value is `null`. + + ' + type: integer + format: int64 + example: 86400000 + BucketAuditFilter: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/BucketAuditFilterBase' + - type: object + properties: + bucket: + description: Reference to the bucket to which this filter belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + CrossOriginResourceSharingPolicyRule: + allOf: + - $ref: '#/components/schemas/_context' + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRulePost' + - type: object + properties: + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + BucketAccessPolicyRule: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/BucketAccessPolicyRulePost' + - type: object + properties: + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + _direction: + type: string + description: 'The direction of replication. Valid values are `inbound` and + + `outbound`. + + ' + readOnly: true + x-read-only: true + _fixedReferenceWithRemote: + allOf: + - $ref: '#/components/schemas/_fixedReference' + - type: object + properties: + remote: + description: The remote field of the corresponding array connection. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + _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/_reference' + - type: object + properties: + configuration: + description: 'The name of the preset configuration object. + + ' + type: string + _group: + type: object + properties: + id: + description: The numeric group id that represents the group's identity in + a POSIX system. + type: integer + format: int64 + name: + description: 'The group name that represents the group''s identity, and + which resolves to the group''s id + + in a configured directory service. + + ' + type: string + _user: + type: object + properties: + id: + description: The numeric user id that represents the user's identity in + a POSIX system. + type: integer + format: int64 + name: + description: 'The user name that represents the user''s identity, and which + resolves to the user''s id + + in a configured directory service. + + ' + type: string + _workloadConfigurationFixedReference: + 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/_fixedReference' + - type: object + properties: + configuration: + description: 'The name of the preset configuration object. + + ' + type: string + readOnly: true + PolicyFileSystemSnapshot: + allOf: + - $ref: '#/components/schemas/PolicyMember' + - $ref: '#/components/schemas/_context' + - type: object + properties: + policy: + description: Reference to the policy. + title: LocationReference + allOf: + - $ref: '#/components/schemas/_locationReference' + _memberLink: + type: object + properties: + local_file_system: + description: Reference to a local file system. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + remote: + description: Reference to a remote array. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + remote_file_system: + description: Reference to a remote file system. + title: FixedReferenceNoResourceType + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoResourceType' + FileLock: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + access_type: + description: 'Type of access the lock provides. Valid values are `shared`, + + `exclusive` and `no-access`. + + ' + type: string + readOnly: true + client: + description: 'Reference to the file system client that holds the lock. + + ' + title: FixedReferenceNoId + allOf: + - $ref: '#/components/schemas/_fixedReferenceNoId' + created_at: + description: 'Creation timestamp of the lock. Measured in milliseconds + since the UNIX + + epoch. + + ' + type: integer + format: int64 + inode: + description: 'The inode of the file where the lock is found relative to + the specified + + `source`. + + ' + type: integer + readOnly: true + path: + description: 'Path to the file where the lock is found relative to `source`. + + If it is longer than 1023 characters, it will be truncated and only + + the last 1023 characters will be returned. + + If multiple hard links exist to the file on which the lock is held, + + only one is returned. + + This field will be `null` if the path cannot be resolved. + + ' + type: string + readOnly: true + protocol: + description: 'The protocol utilized for obtaining and managing the lock. + + Valid values include `NLM`, `NFSv4.1` and `SMB`. + + ' + type: string + readOnly: true + range: + $ref: '#/components/schemas/_fileLockRange' + source: + description: 'Reference to location where the path/inode can be found. + + ' + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + FileSystemClient: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + FileSession: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + authentication: + description: 'Describes how was the user authenticated. + + Valid values include `KRB` and `NTLMv2`. + + ' + type: string + readOnly: true + client: + description: 'Client that holds the session. + + ' + title: FixedReferenceNameOnly + allOf: + - $ref: '#/components/schemas/_fixedReferenceNameOnly' + connection_time: + description: Connection time in milliseconds since UNIX epoch. + type: integer + format: int64 + idle_time: + description: 'Duration in milliseconds that indicates how long + + the session has been idle. + + ' + type: integer + format: int64 + opens: + description: Number of opens for the given session. + type: integer + format: int64 + port: + description: Port number the client is connected from. + type: integer + format: int64 + protocol: + description: 'The protocol utilized for obtaining and managing the session. + + Valid values include `nfs` and `smb`. + + ' + type: string + readOnly: true + time: + description: Current time in milliseconds since UNIX epoch. + type: integer + format: int64 + user: + description: The user who has created the session. + title: User_no_id + allOf: + - $ref: '#/components/schemas/_user_no_id' + FileSystemOpenFile: + type: object + properties: + client: + description: 'Client that has the file open. + + ' + title: FixedReferenceNameOnly + allOf: + - $ref: '#/components/schemas/_fixedReferenceNameOnly' + id: + description: The unique identifier of the open file. + type: string + example: '18446744073709551615' + lock_count: + description: The number of locks on the file. + type: integer + format: int32 + minimum: 0 + mode: + description: 'The mode in which the file is open: "ro" for Read-Only, "wo" + for Write-Only, "rw" for + + Read-Write or "no-access" if no read or write access was granted. + + ' + type: string + path: + description: The path to the open file. + type: string + example: /fs1_export1/path/to/file1.txt + session: + description: 'The name of the session with the open file. + + ' + title: FixedReferenceNameOnly + allOf: + - $ref: '#/components/schemas/_fixedReferenceNameOnly' + source: + description: Reference to the file system. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + user: + description: The user who has the file open. + title: User_no_id + allOf: + - $ref: '#/components/schemas/_user_no_id' + _fleetMemberPostMembersMember: + 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 + _fixedReferenceWithIsLocal: + allOf: + - $ref: '#/components/schemas/_fixedReference' + - $ref: '#/components/schemas/_referenceWithoutTypeWithIsLocal' + - type: object + properties: + resource_type: + description: "Type of the object (full name of the endpoint).\n Valid + values are the unique part of the resource's REST endpoint.\n For example, + a reference to a fleet would have a\n `resource_type` of `fleets`.\n" + type: string + HardwareTemperaturesThresholds: + description: 'The predefined temperature thresholds for the sensor, specifying + acceptable operational limits. + + ' + type: object + properties: + critical: + description: 'The temperature level indicating that the system is under + increased load. + + While still operational, it may require monitoring or adjustments to maintain + optimal performance. + + ' + type: number + format: double + readOnly: true + non_critical: + description: 'The temperature level at which the system operates normally + without any concerns. + + ' + type: number + format: double + readOnly: true + unrecoverable: + description: 'The maximum temperature limit beyond which the system may + experience irreversible failure. + + Immediate action is required to prevent damage or shutdown. + + ' + type: number + format: double + readOnly: true + ManagementAccessPolicyRuleBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - properties: + role: + description: 'Role defines a set of permissions applicable in a scope. + `viewer` grants users + + the ability to read within a scope. `support` grants the ability to + perform general + + support-related actions as well as read within a scope. `storage` grants + access + + to all storage operations within a scope. `admin` grants access to all + operations. + + ' + title: ReferenceNameOnly + allOf: + - $ref: '#/components/schemas/_referenceNameOnly' + scope: + description: 'Reference to the resource (e.g. arrays, realms) which specifies + the scope that + + the role applies. One of `id` or `name` parameter is required, and `resource_type` + + must be set. + + ' + title: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _policyRuleIndexInPolicy: + type: object + properties: + index: + description: 'The index within the policy. The `index` indicates the order + the rules are evaluated. + + ' + type: integer + format: int32 + readOnly: true + ManagementAuthenticationPolicyConfigMethod: + type: string + description: 'The name of the authentication method. Valid values are `default`, + `password`, and `key`. + + `default` is a special value that indicates the default authentication method + for the interface, + + and is potentially interface-specific and version-specific. For now, it means + either `password` + + or `key` is allowed. + + ' + NetworkInterfacePing: + description: 'Output from running the linux command ''ping'' directly + + on the array with start and end location information. + + ' + type: object + properties: + component_name: + description: Name of the component running the check. + type: string + readOnly: true + example: ch1-fm1 + destination: + description: 'The destination address or hostname provided in the request + that the operation is run against. + + ' + type: string + readOnly: true + example: 181.44.543.12 + details: + description: 'Giant text block that contains raw output of the operation + and a client needs to parse. + + ' + type: string + readOnly: true + source: + description: 'The address where the check starts. Can be a subnet or IP + inside the subnet. + + ' + type: string + readOnly: true + example: net1 + NetworkInterfaceTrace: + description: 'Output from running the linux command ''traceroute'' directly + + on the array with start and end location information. + + ' + type: object + properties: + component_name: + description: Name of the component running the check. + type: string + readOnly: true + example: ch1-fm1 + destination: + description: 'The destination address or hostname provided in the request + that the operation is run against. + + ' + type: string + readOnly: true + example: 181.44.543.12 + details: + description: 'Giant text block that contains raw output of the operation + and a client needs to parse. + + ' + type: string + readOnly: true + source: + description: 'The address where the check starts. Can be a subnet or IP + inside the subnet. + + ' + type: string + readOnly: true + example: net1 + NetworkInterfacesConnectorsSettingRoce: + description: 'RoCE(RDMA over Converged Ethernet) configuration for network connectors. + + ' + allOf: + - type: object + properties: + default_ecn: + description: 'The default ECN(Explicit Congestion Notification) setting + for network connectors. + + ' + title: NetworkInterfacesConnectorsSettingRoceEcn + allOf: + - $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingRoceEcn' + default_pfc: + description: 'The default PFC(Priority Flow Control) setting for network + connectors. + + ' + title: NetworkInterfacesConnectorsSettingRocePfc + allOf: + - $ref: '#/components/schemas/NetworkInterfacesConnectorsSettingRocePfc' + enabled: + description: 'If `true`, then RoCE networking is enabled. Otherwise, it + is disabled. + + ' + type: boolean + network_congestion_mode: + description: 'The RoCE network mode to be used. Valid values include `lossy` + and `lossless`. + + For lossy mode, only Explicit Congestion Notification (ECN) is enabled. + + For lossless mode, both ECN and Priority Flow Control (PFC) are enabled. + + ' + type: string + trust_mode: + description: 'The trust mode of the RoCE network. Valid values include + `pcp` and `dscp`. + + ' + type: string + NetworkConnectionStatistics: + description: 'Returns the status of the network connections on the array at + the time of the operation. + + ' + type: object + properties: + current_state: + description: 'Valid values include `CLOSE_WAIT`, `CLOSED`, `ESTABLISHED`, + `FIN_WAIT_1`, `FIN_WAIT_2`, + + `LAST_ACK`, `LISTEN`, `SYN_RECEIVED`, `SYN_SEND`, and `TIME_WAIT` + + ' + type: string + readOnly: true + example: TIME_WAIT + local: + description: 'The information of the array''s network interface to which + the remote connection is bound. + + ' + title: NetworkInterfaceInfo + allOf: + - $ref: '#/components/schemas/_networkInterfaceInfo' + remote: + description: 'Network information of the remote peer that has connected + to the array''s network interface. + + ' + title: NetworkInterfaceInfo + allOf: + - $ref: '#/components/schemas/_networkInterfaceInfo' + time: + description: The time the operation was run. + type: integer + format: int64 + readOnly: true + example: 1735596861 + 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: NetworkInterfaceNeighborLocalPort + allOf: + - $ref: '#/components/schemas/_networkInterfaceNeighborLocalPort' + neighbor_chassis: + title: NetworkInterfaceNeighborNeighborChassis + allOf: + - $ref: '#/components/schemas/_networkInterfaceNeighborNeighborChassis' + neighbor_port: + title: NetworkInterfaceNeighborNeighborPort + allOf: + - $ref: '#/components/schemas/_networkInterfaceNeighborNeighborPort' + x-readOnly: true + ObjectStoreAccessPolicyAction: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_context' + - type: object + properties: + description: + description: 'A description of the action. + + ' + type: string + readOnly: true + example: Grants permission to create a new bucket. + _bucketDefaultsReadonly: + type: object + properties: + hard_limit_enabled: + description: 'The value of this field will be used to configure the `hard_limit_enabled` + + field of newly created buckets associated with this object store account, + + if the bucket creation does not specify its own value. If not specified, + + defaults to `false`. + + ' + type: boolean + quota_limit: + description: 'The value of this field will be used to configure the `quota_limit` + field + + of newly created buckets associated with this object store account, if + the + + bucket creation does not specify its own value. If unset, the bucket + + default is unlimited in size. + + ' + type: integer + TrustPolicyRule: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - $ref: '#/components/schemas/_index' + - $ref: '#/components/schemas/TrustPolicyRulePost' + _resourceFixed: + description: 'A resource that can be created, named, 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 cannot be modified. + + ' + type: string + 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/_fixedReference' + PublicKeyUse: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + use: + description: A reference to an object using this public key. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + _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: '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: 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: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + 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: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _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: Rules describe 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 + ResiliencyGroup: + allOf: + - $ref: '#/components/schemas/_builtIn' + - description: 'A group of nodes that are configured to provide high availability + + in the case of failures within members of the group. + + ' + type: object + properties: + status: + description: 'The status of the resiliency group. + + Valid values include `critical`, `healthy`, and `unhealthy`. + + ' + type: string + readOnly: true + status_details: + description: 'The description of the status of the resiliency group if + not healthy. + + ' + type: string + readOnly: true + _permission: + type: object + properties: + action: + description: 'The `action` that the user can perform on the `resource_type`. + + Typical values include `get`, `patch`, `post`, and `delete`. + + Values can also be finer grained. + + ' + type: string + readOnly: true + example: get + resource_type: + description: The `resource_type` that this `permission` affects. + type: string + readOnly: true + example: file-systems + x-readOnly: true + _policyReference: + type: object + properties: + policy: + description: The policy to which this rule belongs. + title: FixedReference + allOf: + - $ref: '#/components/schemas/_fixedReference' + _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: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + 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: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + ServerContext: + allOf: + - $ref: '#/components/schemas/Server' + - $ref: '#/components/schemas/_context' + SupportDiagnostics: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + analysis_period: + $ref: '#/components/schemas/_start_end_time' + index: + description: The unique index of the task. + type: integer + format: int64 + readOnly: true + example: 1 + severity_count: + description: 'List of severity counts. + + ' + type: array + items: + $ref: '#/components/schemas/_supportDiagnosticsSeverityCount' + start_time: + description: Start time in milliseconds since the UNIX epoch. + type: integer + format: int64 + example: 1567026779000 + x-minimum: 0 + status: + description: 'Status of the diagnostics. + + A status of `running` indicates that the diagnostics is still running. + + A status of `completed` indicates that the diagnostics has completed. + + A status of `failed` indicates that the diagnostics has failed. + + ' + type: string + example: completed + task_id: + description: 'A globally unique, system-generated ID. The ID cannot be + modified. + + ' + type: string + readOnly: true + version: + description: Version of diagnostics tool. + type: string + example: 1.0.4.0 + SupportDiagnosticsDetails: + allOf: + - $ref: '#/components/schemas/_builtIn' + - type: object + properties: + index: + description: 'The unique index of the test. It will be of the format A.B + + where A is the task index and B is the test index. + + ' + type: number + readOnly: true + example: 1.1 + result_details: + description: 'More details related to the test. + + This field can provide remediation information as well. + + ' + type: string + example: Subnets does not exist for Mgmt services. + severity: + description: 'Severity level of the test. + + Valid values include `info`, `warning`, `critical`. + + ' + type: string + example: critical + task_id: + description: 'The task ID of the diagnostics for which this refers to. + + ' + type: string + readOnly: true + test_name: + description: 'Name of the test that was performed. + + ' + type: string + example: Subnet Check For Management Service + test_type: + description: 'Category to which the test belongs to. + + ' + type: string + example: Generic + _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 + _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: Empty Chassis Check + 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 + SyslogServerContext: + allOf: + - $ref: '#/components/schemas/SyslogServer' + - $ref: '#/components/schemas/_context' + TargetWithContext: + allOf: + - $ref: '#/components/schemas/Target' + - $ref: '#/components/schemas/_context' + _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/_fixedReference' + - 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/_referenceWritable' + _workloadPlacementRecommendationParameterConstraints: + description: Constraints to apply 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/_referenceWritable' + - description: 'Data for a target in a workload placement recommendation. + + Target is a array, which 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 in which + this array should be used. + + ' + type: array + items: + type: string + placement_configurations: + description: 'The preset placement configurations in which this array + should be used. + + ' + type: array + items: + type: string + warnings: + description: 'The warnings for the target. + + ' + type: array + items: + $ref: '#/components/schemas/_workloadPlacementRecommendationWarning' + AuditFileSystemsPolicyRuleBase: + allOf: + - $ref: '#/components/schemas/_builtIn' + - properties: + op_status: + description: 'Status of the operation to be audited by this rule. + + Valid values include ''success'' or failure''. + + ' + type: string + example: success + operations: + description: 'The list of operations to be audited by this rule. Supported + ops are returned by the + + /audit-file-systems-policy-operations endpoint. + + ' + type: array + items: + type: string + example: + - read + - write + - getattr + BucketAuditFilterAction: + allOf: + - $ref: '#/components/schemas/_builtInNoId' + - type: object + properties: + description: + description: 'A description of the action. + + ' + type: string + readOnly: true + example: Configures auditing on creation of objects in a bucket. + _fileLockRange: + description: 'The range in bytes (`offset`, `length`) the lock covers within + a file. + + If the lock reaches the end of the file, the `length` will be `null`. + + If the lock is set for the entire file, both `offset` and `length` + + will be `null`. + + ' + type: object + properties: + length: + type: integer + readOnly: true + offset: + type: integer + readOnly: true + _fixedReferenceNoId: + type: object + properties: + name: + type: string + readOnly: true + 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-readOnly: true + _user_no_id: + type: object + properties: + name: + description: 'The user name that represents the user''s identity, and which + resolves to the user''s id + + in a configured directory service. + + ' + type: string + _referenceWithoutTypeWithIsLocal: + allOf: + - $ref: '#/components/schemas/_referenceWithoutType' + - 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 + NetworkInterfacesConnectorsSettingRoceEcn: + description: 'Default ECN(Explicit Network Notification) configuration for network + connectors. + + ' + allOf: + - type: object + properties: + marking_probability: + description: 'The ECN marking probability when min ECN marked threshold + is reached. + + ' + type: number + format: float + readOnly: true + max_ecn_marked_threshold: + description: 'The maximum threshold value in bytes at which the packets + start being marked with ECN + + at the highest probability or dropped. + + ' + type: integer + format: int32 + readOnly: true + min_ecn_marked_threshold: + description: 'The minimum threshold value in bytes at which the packets + start being marked with ECN. + + ' + type: integer + format: int32 + readOnly: true + NetworkInterfacesConnectorsSettingRocePfc: + description: 'Default PFC(Priority Flow Control) configuration for network connectors. + + ' + allOf: + - type: object + properties: + port_buffer: + description: 'The buffer size in bytes reserved to absorb in-flight packets + after XOFF threshold + + is reached. + + ' + type: integer + format: int32 + readOnly: true + xoff_threshold: + description: 'The PFC XOFF threshold value in bytes. When the buffer for + a particular traffic class + + reaches this threshold, the pause frame(XOFF) will be transimitted to + the sender, + + requesting it to stop sending packets for that class. + + ' + type: integer + format: int32 + readOnly: true + xon_threshold: + description: 'The PFC XON threshold value in bytes. When the buffer for + a particular traffic class + + drops below this threshold, the un-pause frame(XON) will be transmitted + to the sender, + + requesting it to resume sending packets for that class. + + ' + type: integer + format: int32 + readOnly: true + _networkInterfaceInfo: + type: object + properties: + address: + description: The address of the network interface. + type: string + readOnly: true + example: 168.192.0.1 + port: + description: The port number of the network interface. + type: string + readOnly: true + example: '8080' + x-readOnly: true + _networkInterfaceNeighborLocalPort: + type: object + properties: + name: + description: A name of the local port. + type: string + example: CH1.FM2.ETH1 + _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' + _index: + type: object + properties: + index: + description: Index of the object in the containing array. + type: integer + readOnly: true + _presetWorkloadConfigurationName: + type: string + description: 'The name of the configuration object, by which other configuration + objects in the preset + + can reference it. 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: 'A naming pattern for the name of the export used by clients + to mount the file system or directory. + + Export names must be unique within the same protocol+server combination. + + ' + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/_namingPattern' + servers: + description: 'An optional reference to a parameterized server resource. + + Defaults to _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: 'A reference to an existing file system. + + Supports parameterization. + + ' + title: ReferenceWithoutType + allOf: + - $ref: '#/components/schemas/_referenceWithoutType' + _presetWorkloadDirectoryConfigurationPath: + type: object + properties: + naming_patterns: + description: 'A naming pattern for the directory path. + + ' + type: array + minItems: 1 + maxItems: 1 + items: + $ref: '#/components/schemas/_namingPattern' + _presetWorkloadDirectoryConfigurationSpecialDirectories: + type: object + properties: + fast_remove: + description: 'If set to "true", the file system or directory, when mounted, + will + + contain a directory that can be used for fast removal of other directories. + + Directories can be moved into the fast remove directory in order to have + + them deleted, and their space freed, more quickly than a normal removal + + operation. + + Defaults to "false". + + Supports parameterization. + + ' + type: string + snapshot: + description: 'If set to "true", a hidden .snapshot directory will be present + in each + + directory of the file system when it is mounted. + + The .snapshot directory allows clients read access to the contents of + + the snapshots that have been taken of a directory. + + If set to "false", the .snapshot directory will not be present in any + + directories within a mounted file system. + + Defaults to "true". + + 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. + + 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. + + Supports parameterization. + + ' + type: string + keep_for: + description: 'Specifies the period that snapshots are retained before they + are eradicated, in milliseconds. + + 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. + + 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. + + 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: 'Logical space limit of the quota assigned by the rule, measured + in bytes. + + This value cannot be set to 0. + + Supports parameterization. + + ' + type: string + _supportDiagnosticsSeverityCount: + type: object + properties: + count: + description: 'Count of the corresponding severity. + + ' + type: integer + example: 1 + severity: + description: 'Severity level of the test. + + Valid values include `info`, `warning`, `critical`. + + ' + type: string + example: critical + _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: Constraints to apply to parameters of resource reference type. + type: object + properties: + allowed_values: + description: 'The valid values that can be supplied to the parameter to + create a workload. + + ' + type: array + items: + $ref: '#/components/schemas/_referenceWithoutType' + _workloadPlacementRecommendationTarget: + allOf: + - $ref: '#/components/schemas/_referenceWritable' + - description: 'Data for a target in a workload placement recommendation. + + Target is a FlashArray, which 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 + 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 + _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 an NFS export configuration defined in this preset. + + ' + type: string + smb: + description: 'The name of an SMB export configuration defined in this preset. + + ' + type: string + smb_share: + description: 'The name of an SMB share export configuration defined in this + preset. + + ' + type: string + _presetWorkloadDirectoryConfigurationName: + type: object + properties: + name: + description: 'The name of a directory_configuration within this Preset. + + ' + type: string + _presetWorkloadExportConfigurationNfsPolicy: + type: object + properties: + rules: + type: array + items: + $ref: '#/components/schemas/_presetWorkloadExportConfigurationNfsRule' + user_mapping_enabled: + description: 'If "true", queries the joined AD/OpenLDAP server to find the + user + + corresponding to the incoming UID. + + If "false", users are defined by UID/GID pair. + + Supports parameterization. + + ' + type: string + _presetWorkloadExportConfigurationSmbPolicy: + 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". + + Supports parameterization. + + ' + type: string + 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 "true". + + 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: ReferenceWritable + allOf: + - $ref: '#/components/schemas/_referenceWritable' + _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: '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. + + Supports parameterization. + + ' + 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. + + Supports parameterization. + + ' + type: string + 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. + + Supports parameterization. + + ' + type: string + atime: + description: 'If `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 `false`, disables the update of inode access times after read operations. + + Defaults to `true`. + + 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 + nfs_version: + description: 'The NFS protocol version allowed for the export. Valid values + are `nfsv3` and `nfsv4`. + + Supports parameterization. + + ' + 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 `ro` if not specified. + + Supports parameterization. + + ' + type: string + secure: + description: 'If `true`, prevents NFS access to client connections coming + from non-reserved ports. Applies + + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + + If `false`, allows NFS access to client connections coming from non-reserved + ports. Applies + + to NFSv3, NFSv4.1, and auxiliary protocols MOUNT and NLM. + + The default is `false` if not specified. + + Supports parameterization. + + ' + type: string + security: + description: 'The security flavors to use for accessing files on this mount + point. If the server does not + + support the requested flavor, the mount operation fails. + + If `sys`, trusts the client to specify user''s identity. + + If `krb5`, provides cryptographic proof of a user''s identity 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 in order to + + enable Kerberos security. + + If `krb5i`, adds integrity checking to krb5, to ensure the data has not + been tampered with. + + If `krb5p`, adds integrity checking and encryption to krb5. This is the + most secure setting, + + but it also involves the most performance overhead. + + The default is `sys` if not specified. + + Supports parameterization. + + ' + type: array + items: + type: string + example: sys + _presetWorkloadExportConfigurationSmbRule: + type: object + properties: + anonymous_access_allowed: + description: 'Specifies whether access to information is allowed for anonymous + users. + + If not specified, defaults to "false". + + 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: + 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 + 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 + Ids: + name: ids + in: query + description: 'A comma-separated list of resource IDs. + + If after filtering, there is not at least one resource that matches + + each of the elements of `ids`, then an error is returned. + + This cannot be provided together with the `name` or `names` query parameters. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Offset: + name: offset + in: query + description: 'The offset of the first resource to return from a collection. + + ' + schema: + type: integer + format: int32 + minimum: 0 + example: 10 + Sort: + name: sort + in: query + description: 'Sort the response by the specified fields (in descending order + if ''-'' + + is appended to the field name). + + NOTE: If you provide a sort you will not get a `continuation_token` in + + the response. + + ' + style: form + explode: false + schema: + type: array + items: + pattern: ^[a-z]+(_[a-z]+)*-? + type: string + 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 to a pre-existing account must have permissions + to + + ''read attributes from'' and ''reset the password of'' the pre-existing account. + + `service_principal_names`, `encryption_types`, and `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 + Expose_api_token: + name: expose_api_token + in: query + description: 'If `true`, exposes the API token of the current user. + + ' + schema: + type: boolean + Admin_ids: + name: admin_ids + in: query + description: 'A comma-separated list of admin IDs. If after filtering, there + is not + + at least one admin resource that matches each of the elements, then an error + + is returned. This cannot be provided together with the `admin_names` query + + parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Admin_names: + name: admin_names + in: query + description: 'A comma-separated list of admin names. If there is not at least + one + + admin resource that matches each of the elements, then an error is returned. + + This cannot be provided together with `admin_ids` query parameter. + + ' + 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 + Refresh: + name: refresh + in: query + description: 'Whether to refresh the user info from directory service. + + If not specified, defaults to `false`. + + ' + schema: + type: boolean + Member_ids: + name: member_ids + in: query + description: 'A comma-separated list of member IDs. + + If after filtering, there is not at least one resource that matches + + each of the elements of `member_ids`, then an error is returned. + + This cannot be provided together with the `member_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Member_names: + name: member_names + in: query + description: 'A comma-separated list of member names. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Policy_ids: + name: policy_ids + in: query + description: 'A comma-separated list of policy IDs. + + If after filtering, there is not at least one resource that matches + + each of the elements of `policy_ids`, then an error is returned. + + This cannot be provided together with the `policy_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Policy_names: + name: policy_names + in: query + description: 'A comma-separated list of policy names. + + ' + 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 + Names_required: + name: names + in: query + description: 'A comma-separated list of resource names. + + ' + required: true + style: form + explode: false + schema: + type: array + items: + type: string + Total_only: + name: total_only + in: query + description: 'If set to `true`, returns the aggregate value of all items after + filtering. + + Where it makes more sense, the average value is displayed instead. + + The values are displayed for each name where meaningful. + + If `total_only=true`, the `items` list will be empty. + + ' + schema: + type: boolean + Protocol_clients: + name: protocol + in: query + description: 'Display the performance of a specified protocol. + + Valid values are `NFS`, and `S3`. + + If not specified, defaults to `NFS`. + + ' + schema: + 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 + Remote_ids_deprecated: + name: remote_ids + in: query + description: 'A comma-separated list of remote array IDs. Deprecated, best practice + is to reference connections + + with `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_deprecated: + name: remote_names + in: query + description: 'A comma-separated list of remote array names. Deprecated, best + practice is to reference + + connections with `ids`. If there is not at least one resource that matches + each of the elements, + + then an error is returned. This cannot be provided together with `remote_ids` + query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + End_time: + name: end_time + in: query + description: 'When the time window ends (in milliseconds since epoch). + + ' + schema: + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + Resolution: + name: resolution + in: query + description: 'The desired ms between samples. Available resolutions may + + depend on data type, `start_time` and `end_time`. + + In general `1000`, `30000`, `300000`, `1800000`, `7200000`, and + + `86400000` are possible values. + + ' + schema: + type: integer + format: int64 + minimum: 0 + example: 30000 + Start_time: + name: start_time + in: query + description: 'When the time window starts (in milliseconds since epoch). + + ' + schema: + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + Type_for_performance: + name: type + in: query + description: 'Display the metric of a specified object type. + + Valid values are `all`, `file-system`, and `object-store`. + + If not specified, defaults to `all`. + + ' + schema: + type: string + Protocol: + name: protocol + in: query + description: 'Display the performance of a specified protocol. + + Valid values are `all`, `HTTP`, `SMB`, `NFS`, and `S3`. + + If not specified, defaults to `all`, which will provide + + the combined performance of all available protocols. + + ' + schema: + type: string + Type: + name: type + in: query + description: 'Display the metric of a specified object type. + + Valid values are `array`, `file-system`, and `object-store`. + + If not specified, defaults to `array`. + + ' + schema: + type: string + StorageClassNames: + name: storage_class_names + in: query + description: 'A comma-separated list of storage class names. Valid values include + `S500X-S` and `S500X-A`. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Eradicate_all_data_required: + name: eradicate_all_data + in: query + required: true + description: 'Set to `true` to perform a factory reset. + + ' + schema: + type: boolean + default: true + Preserve_configuration_data_required: + name: preserve_configuration_data + in: query + required: true + description: 'For the initial phase `none` is only acceptable value for this + parameter + + ' + schema: + type: string + default: none + Skip_phonehome_check: + name: skip_phonehome_check + in: query + required: true + description: 'A flag to skip phonehome connectivity check. + + Arrays that intentionally disable phonehome or do not permit connectivity + + to Pure Storage''s cloud servers must set this flag to `true` in order to + start factory reset. + + ' + schema: + type: boolean + default: false + Delete_sanitization_certificate_required: + name: delete_sanitization_certificate + in: query + required: true + description: 'Must be `true` to finalize factory reset and acknowledge the deletion + of sanitization certificate. + + ' + schema: + type: boolean + default: true + Finalize_array_erasure_required: + name: finalize + in: query + required: true + description: 'Must be `true` to finalize factory reset. + + ' + schema: + type: boolean + default: true + 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 + Cancel_storage_class_transition: + name: cancel_in_progress_storage_class_transition + in: query + description: 'If set to `true`, the storage class policy of this file system + + will be set to the requested storage class policy, even if + + a transition to a different storage class is in-progress. + + Setting this parameter to `true` is acknowledgement that any + + in-progress transition on this file system will be cancelled. + + If not specified, the default value is `false`. + + ' + schema: + type: boolean + Ignore_usage: + name: ignore_usage + in: query + description: 'Allow update operations that lead to a `hard_limit_enabled` object + store + + account, bucket, or file system with usage over its limiting value. + + For object store accounts and buckets, the limiting value is that of `quota_limit`, + + and for file systems it is that of `provisioned`. + + The operation can be setting `hard_limit_enabled` when usage is higher + + than the limiting value, modifying the limiting value to a value under usage + when + + `hard_limit_enabled`, recovering a destroyed bucket of an object store account + + that causes an account''s space usage to go over its hard `quota_limit`. + + Also allows update operations that would cause usage of the requested + + storage class to go over its warning threshold. + + ' + 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 + Local_bucket_ids: + name: local_bucket_ids + in: query + description: 'A comma-separated list of local bucket 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_bucket_names` + + query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Local_bucket_names: + name: local_bucket_names + in: query + description: 'A comma-separated list of local bucket names. If there is not + at least one + + resource that matches each of the elements, then an error is returned. This + + cannot be provided together with `local_bucket_ids` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Remote_bucket_names: + name: remote_bucket_names + in: query + description: 'A comma-separated list of remote bucket names. If 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_credentials_ids: + name: remote_credentials_ids + in: query + description: 'A comma-separated list of remote credentials 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_credentials_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Remote_credentials_names: + name: remote_credentials_names + in: query + description: 'A comma-separated list of remote credentials names. If 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_credentials_ids` query + + parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + 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: 'A comma-separated list of certificate names. + + If there is not at least one resource that matches each of the + + elements of `certificate_names`, then an error is returned. + + This cannot be provided in conjunction with the `certificate_ids` + + parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Ids_for_directory_service_roles: + name: ids + in: query + description: 'A comma-separated list of resource IDs. + + If after filtering, there is not at least one resource that matches + + each of the elements of `ids`, then an error is returned. + + This cannot be provided together with the `names`, `role_names`, + + or `role_ids` query parameters. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Names_for_directory_service_roles: + name: names + in: query + description: 'A comma-separated list of resource IDs. + + If after filtering, there is not at least one resource that matches + + each of the elements of `names`, then an error is returned. + + This cannot be provided together with the `ids`, `role_names`, + + or `role_ids` query parameters. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Role_ids: + name: role_ids + in: query + description: 'A comma-separated list of role_ids. + + If after filtering, there is not at least one resource that matches + + each of the elements of `role_ids`, then an error is returned. + + This cannot be provided together with the `ids`, `names` or + + `role_names` query parameters. + + This query parameter is deprecated for use with directory service + + roles. If this parameter is used to query or modify directory + + service roles, but more than 1 configuration exists with a given + + role id, an error will be returned in order to avoid ambiguous + + operation. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Role_names: + name: role_names + in: query + description: 'A comma-separated list of role_names. + + If there is not at least one resource that matches + + each of the elements of `role_names`, then an error is returned. + + This cannot be provided together with the `ids`, `names`, + + or `role_ids` query parameters. + + This query parameter is deprecated for use with directory service + + roles. If this parameter is used to query or modify directory + + service roles, but more than 1 configuration exists with a given + + role name, an error will be returned in order to avoid ambiguous + + operation. + + ' + 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 + Default_exports: + name: default_exports + in: query + description: 'A comma-separated list of export types to be created using default + access. + + Creating a file system with an explicit `nfs.rules` or `nfs.export_policy` + value will always + + create a NFS export to the default server regardless of this flag. If these + are not set and + + `default_exports` includes `nfs`, then `nfs.rules` will be set to "*(rw,no_root_squash)" + + and a NFS export to the default server will be created. Otherwise `nfs.rules` + will be set to "" + + and no NFS export will be created. + + Creating a file system with an explicit `smb.client_policy` or `smb.share_policy` + value will + + always create a SMB export to the default server regardless of this flag. + If these are not set + + and `default_exports` includes `smb`, then a SMB export to the default server + will be + + created with default policies. Otherwise no SMB export will be created. + + Use empty string ("") to not create these default exports. + + Default is `nfs,smb`. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + example: nfs,smb + Discard_non_snapshotted_data: + name: discard_non_snapshotted_data + in: query + description: 'This parameter must be set to `true` in order to restore + + a file system from a snapshot or to demote a file system + + (which restores the file system from the common baseline + + snapshot). Setting this parameter to `true` is acknowledgement + + that any non-snapshotted data currently in the file system + + will be irretrievably lost. + + ' + schema: + type: boolean + Overwrite: + name: overwrite + in: query + description: 'When used for snapshot restore, overwrites (`true`) an existing + file system. + + ' + schema: + type: boolean + Delete_link_on_eradication: + name: delete_link_on_eradication + in: query + description: 'If set to `true`, the file system can be destroyed, even if it + has a replica link. + + If set to `false`, the file system cannot be destroyed if it has a replica + link. + + Defaults to `false`. + + ' + schema: + type: boolean + Discard_detailed_permissions: + name: discard_detailed_permissions + in: query + description: 'This parameter must be set to `true` in order to change + + a file system''s `access_control_style` from a style that + + supports more detailed access control lists to a style that + + only supports less detailed mode bits as a form of permission + + control. + + This parameter may not be set to `true` any other time. + + Setting this parameter to `true` is acknowledgement that any + + more detailed access control lists currently set within the + + file system will be lost, and NFS permission controls will + + only be enforced at the granularity level of NFS mode bits. + + ' + schema: + type: boolean + File_system_ids: + name: file_system_ids + in: query + description: 'A comma-separated list of file system IDs. + + If after filtering, there is not at least one resource that matches + + each of the elements of `file_system_ids`, then an error is returned. + + This cannot be provided together with the `file_system_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + File_system_names: + name: file_system_names + in: query + description: 'A comma-separated list of file system names. + + If there is not at least one resource that matches + + each of the elements of `file_system_names`, then an error is returned. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Gids_not_strict: + name: gids + in: query + description: 'A comma-separated list of group IDs. + + This cannot be provided together with `group_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Group_names_not_strict: + name: group_names + in: query + description: 'A comma-separated list of group names. + + This cannot be provided together with `gids` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Uids_not_strict: + name: uids + in: query + description: 'A comma-separated list of user IDs. + + This cannot be provided together with `user_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + User_names_not_strict: + name: user_names + in: query + description: 'A comma-separated list of user names. + + This cannot be provided together with `uids` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Local_file_system_ids: + name: local_file_system_ids + in: query + description: 'A comma-separated list of local file system 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_file_system_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Local_file_system_names: + name: local_file_system_names + in: query + description: 'A comma-separated list of local file system names. If there is + not + + at least one resource that matches each of the elements, then an error + + is returned. This cannot be provided together with `local_file_system_ids` + + query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Remote_file_system_ids: + name: remote_file_system_ids + in: query + description: 'A comma-separated list of remote file system IDs. If 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_file_system_names` + + query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Remote_file_system_names: + name: remote_file_system_names + in: query + description: 'A comma-separated list of remote file system names. If 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_file_system_ids` + + query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Cancel_in_progress_transfers: + name: cancel_in_progress_transfers + in: query + description: 'This parameter must be set to `true` in order to delete + + a file system replication link (which can cancel any + + in-progress replication transfers). Setting this parameter + + to `true` is acknowledgement that any in-progress replication + + transfers on the specified links will be cancelled when + + this request is fulfilled. + + ' + schema: + type: boolean + Replicate_now: + name: replicate_now + in: query + description: 'If set to `true`, replicates the contents to the specified targets. + + The `replicate_now` parameters can only be `true` with the partial-replica + file system links. + + ' + schema: + type: boolean + Names_or_owner_names: + name: names_or_owner_names + in: query + description: 'A comma-separated list of resource names. + + Either the names of the snapshots or the owning file systems. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Owner_ids: + name: owner_ids + in: query + description: 'A comma-separated list of owning file system IDs. + + If after filtering, there is not at least one resource that matches + + each of the elements of owner IDs, then an error is returned. + + This cannot be provided together with the `ids`, `names_or_owner_names`, + + or `names_or_sources` query parameters. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Send: + name: send + in: query + description: 'Whether to replicate created snapshots immediately to other arrays. + + If it''s `false`, created snapshots may still be replicated to other arrays + + according to policy. + + ' + schema: + type: boolean + Source_ids: + name: source_ids + in: query + description: 'A comma-separated list of source file system IDs. + + If after filtering, there is not at least one resource that matches + + each of the elements of `source_ids`, then an error is returned. + + This cannot be provided together with the `names_or_sources` or + + `sources` query parameters. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Source_names: + name: source_names + in: query + description: 'A comma-separated list of names for the source of the object. + + If there is not at least one resource that matches each of the elements of + + `source_names`, an error is returned. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Targets: + name: targets + in: query + description: 'The target arrays to replicate created snapshots to. + + Only valid when `send` is `true`. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Latest_replica: + name: latest_replica + in: query + description: 'Used when destroying a snapshot. If not present or `false`, and + the snapshot + + is the latest replicated snapshot, then destroy will fail. If `true` or the + + snapshot is not the latest replicated snapshot, then destroy will be + + successful. + + ' + schema: + type: boolean + Client_names: + name: client_names + in: query + description: 'A comma-separated list of ip addresses of clients. + + For IPv6 both the extended format (x:x:x:x:x:x:x:x) and the shortened + + format are supported. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Inodes: + name: inodes + in: query + description: 'A comma-separated list of inodes used for filtering file locks + query by inodes. + + This may only be specified if `file_system_ids` or `file_system_names` is + + also specified. + + This cannot be provided together with the `paths` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: number + Paths: + name: paths + in: query + description: 'A comma-separated list of paths used for filtering file locks + query by paths. + + This may only be specified if `file_system_ids` or `file_system_names` is + + also specified. + + This cannot be provided together with the `inodes` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Recursive: + name: recursive + in: query + description: 'Flag used to indicate that the action should be done recursively. + + If set to `true` and used e.g. with `path` pointing to a directory, the + + operation will delete all locks in given directory and subdirectories recursively. + + For more fine grained control over deleted locks, use delete by name. + + If not specified, defaults to `false`. + + ' + schema: + type: boolean + Protocols: + name: protocols + in: query + description: 'A comma-separated list of file protocols. + + Valid values include `nfs` and `smb`. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Sessions_user_names: + name: user_names + in: query + description: 'A comma-separated list of user names. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Disruptive: + name: disruptive + in: query + description: 'If set to `true`, a wide scope of sessions may be deleted + + in a single action using a single query parameter from + + `user_names`, `client_names`, or `protocols`. Otherwise, + + multiple query parameters must be specified to narrow + + the impact of deletion and avoid potential for accidental + + disruption of clients. + + ' + schema: + type: boolean + Open_files_paths: + name: paths + in: query + description: 'A comma-separated list of paths used for filtering open files + query. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + example: /fs1_export1/path/to/file1,/fs1_export1/path/to/file2 + Open_files_user_names: + name: user_names + in: query + description: 'A comma-separated list of user names used for filtering open files + query. + + Files opened by any of the specified users will be returned. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + example: DomainName\User1,DomainName\User2 + Protocols_required: + name: protocols + in: query + description: 'A comma-separated list of file protocols. + + Valid values include `nfs` and `smb`. + + ' + required: true + style: form + explode: false + schema: + type: array + items: + type: string + Session_names: + name: session_names + in: query + description: 'A comma-separated list of session names used for filtering open + files query. + + Files opened in any of the specified sessions will be returned. + + ' + style: form + explode: false + schema: + type: array + 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 + 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 + 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 + Name_prefixes: + name: name_prefixes + in: query + description: 'The prefix to use for the names of all Kerberos keytab objects + + that are being created. + + ' + schema: + type: string + Keytab_ids: + name: keytab_ids + in: query + description: 'A comma-separated list of keytab 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 `keytab_names` query + + parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Keytab_names: + name: keytab_names + in: query + description: 'A comma-separated list of keytab names. If there is not at least + one + + resource that matches each of the elements, then an error is returned. This + + cannot be provided together with `keytab_ids` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Legal_holds_recursive: + name: recursive + in: query + description: 'This is a flag to set when recursively applying/releasing legal + holds on entities. + + By default, it is set to be false. + + The `recursive` flag is required when applying/releasing a hold to/from a + directory. + + ' + schema: + type: boolean + default: false + Legal_holds_release: + name: released + in: query + description: 'This is a flag to set when releasing an attached legal hold from + a path. + + ' + required: true + schema: + type: boolean + default: true + 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 + Management_access_policies_member_types: + name: member_types + in: query + description: 'A comma-separated list of member types. Valid values are `admins` + and `arrays`. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Versions: + name: versions + in: query + description: 'A comma-separated list of versions. This is an optional query + param used for concurrency control. + + The ordering should match the names or ids query param. + + This will fail with a 412 Precondition failed if the resource was changed + and the current + + version of the resource doesn''t match the value in the query param. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Before_rule_id: + name: before_rule_id + in: query + description: 'The id of the rule to insert or move a rule before. + + This cannot be provided together with the `before_rule_name` query parameter. + + ' + schema: + type: string + Before_rule_name: + name: before_rule_name + in: query + description: 'The name of the rule to insert or move a rule before. + + This cannot be provided together with the `before_rule_id` query parameter. + + ' + schema: + type: string + Packet_size: + name: packet_size + in: query + description: 'Used by ping to specify the number of data bytes to be sent per + packet. + + If not specified, defaults to 56. + + ' + schema: + type: integer + format: int32 + example: 56 + Ping_count: + name: count + in: query + description: 'Used by ping to specify the number of packets to send. + + If not specified, defaults to 1. + + ' + schema: + type: integer + format: int32 + Ping_trace_component: + name: component_name + in: query + description: 'Used by ping and trace to specify where to run the operation. + Valid values are controllers + + and blades from hardware list. + + If not specified, defaults to all available controllers and selected blades. + + ' + schema: + type: string + Ping_trace_destination: + name: destination + in: query + description: 'A destination specified by user to run the network diagnosis against. + Can be a hostname or an IP. + + ' + required: true + schema: + type: string + example: www.test.com + Ping_trace_source: + name: source + in: query + description: 'Used by ping and trace to specify the property where to start + + to run the specified operation. The property can be subnet or + + IP. + + ' + schema: + type: string + Print_latency: + name: print_latency + in: query + description: 'Used by ping to specify whether or not to print + + the full user-to-user latency. If not specified, defaults to false. + + ' + schema: + type: boolean + Resolve_hostname: + name: resolve_hostname + in: query + description: 'Used by ping and trace to specify whether or not to + + map IP addresses to host names. If not specified, defaults to true. + + ' + schema: + type: boolean + Fragment_packet: + name: fragment_packet + in: query + description: 'Used by trace to specify whether or not to + + fragment packets. If not specified, defaults to true. + + ' + schema: + type: boolean + Method: + name: method + in: query + description: 'Used by trace to specify which method to use for trace operations. + Valid + + values are `icmp`, `tcp`, and `udp`. If not specified, defaults to ''udp''. + + ' + schema: + type: string + Mtu: + name: discover_mtu + in: query + description: 'Used by trace to specify whether or not to discover + + the MTU along the path being traced. If not specified, defaults to false. + + ' + schema: + type: boolean + Port: + name: port + in: query + description: 'Used by trace to specify a destination port. + + ' + schema: + type: string + NetworkConnectionStatisticsCurrent_state: + name: current_state + in: query + description: 'The state to filter the results by. If specified, the results + will + + only include connections which current state matches the specified states. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + NetworkConnectionStatisticsLocal_host: + name: local_host + in: query + description: 'The local IP address to filter the results by. If specified, the + results will + + only include connections that are either to or from the specified local host. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + NetworkConnectionStatisticsLocal_port: + name: local_port + in: query + description: 'The local port to filter the results by. If specified, the results + will + + only include connections that are either to or from the specified local port. + + ' + style: form + explode: false + schema: + type: array + items: + type: integer + NetworkConnectionStatisticsRemote_host: + name: remote_host + in: query + description: 'The remote IP address to filter the results by. If specified, + the results will + + only include connections that are either to or from the specified remote host. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + NetworkConnectionStatisticsRemote_port: + name: remote_port + in: query + description: 'The remote port to filter the results by. If specified, the results + will + + only include connections that are either to or from the specified remote port. + + ' + style: form + explode: false + schema: + type: array + items: + type: integer + 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 + 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, `CH1.FM2.ETH1,CH1.FM1.ETH2`. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Add_to_groups: + name: add_to_groups + in: query + description: 'If `true`, the node being added will automatically be added + + to all node groups that other members of its resiliency + + group already belong to. This parameter must be set to `true` + + when adding any node that will be part of a resiliency group. + + ' + schema: + type: boolean + Node_group_ids: + name: node_group_ids + in: query + description: 'A comma-separated list of node group ids. + + If there is not at least one resource that matches each of the + + elements of `node_group_ids`, then an error is returned. + + This cannot be provided in conjunction with the `node_group_names` parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Node_group_names: + name: node_group_names + in: query + description: 'A comma-separated list of node group names. + + If there is not at least one resource that matches each of the + + elements of `node_group_names`, then an error is returned. + + This cannot be provided in conjunction with the `node_group_ids` parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Node_ids: + name: node_ids + in: query + description: 'A comma-separated list of node ids. + + If there is not at least one resource that matches each of the + + elements of `node_ids`, then an error is returned. + + This cannot be provided in conjunction with the `node_names` + + parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Node_names: + name: node_names + in: query + description: 'A comma-separated list of node names. + + If there is not at least one resource that matches each of the + + elements of `node_names`, then an error is returned. + + This cannot be provided in conjunction with the `node_ids` + + parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Access_key_names: + name: names + in: query + description: 'A comma-separated list of resource names to import. + + To import a set of credentials, this field must be specified + + with the `secret_access_key` body parameter. If both of these + + are not specified, the system will generate a new set of credentials. + + + A matching realm prefix is required when importing credentials for + + a user in a realm. For example, use + + `realm1::PSFBSAZRBHOODCBADKNFKCBCPCNHLHMEJOIOHHBACEL` when importing + + credentials for user `realmName::accountName/userName`. + + ' + 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 + Enforce_action_restrictions: + name: enforce_action_restrictions + in: query + description: 'Certain combinations of actions and other rule elements are inherently + ignored + + if specified together in a rule. + + If set to `true`, operations which attempt to set these combinations will + + fail. + + If set to `false`, such operations will instead be allowed. + + Defaults to `true`. + + ' + schema: + type: boolean + Object_store_role_ids: + name: role_ids + in: query + description: 'A comma-separated list of object store role IDs. + + If after filtering, there is not at least one resource that matches + + each of the elements of `role_ids`, then an error is returned. + + This cannot be provided together with the `role_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Object_store_role_names: + name: role_names + in: query + description: 'A comma-separated list of object store role names. + + If there is not at least one resource that matches + + each of the elements of `role_names`, then an error is returned. + + This cannot be provided together with the `role_ids` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Indices: + name: indices + in: query + description: 'A comma-separated list of resource indices. + + If there is not at least one resource that matches + + each of the elements of `indices`, then an error is returned. + + ' + style: form + explode: false + schema: + type: array + items: + type: integer + Full_access: + name: full_access + in: query + description: 'If set to `true`, creates an object store user with full permissions. + + If set to `false`, creates an object store user with no permission. + + If not specified, defaults to `false`. + + ' + schema: + type: boolean + Destroy_snapshots: + name: destroy_snapshots + in: query + description: 'This parameter must be set to `true` in order to modify a policy + such + + that local or remote snapshots would be destroyed. + + ' + schema: + type: boolean + Member_types: + name: member_types + in: query + description: 'A comma-separated list of member types. Valid values include `file-systems`, + + `file-system-snapshots`, `file-system-replica-links`, `object-store-users`, + + and `object-store-accounts`. Different endpoints may accept different subsets + + of these values. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Member_types_qos: + name: member_types + in: query + description: 'A comma-separated list of member types. Valid values are `file-systems`, + `realms`, and `buckets` + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Member_types_qos_no_buckets: + name: member_types + in: query + description: 'A comma-separated list of member types. Valid values are `file-systems`, + `realms` + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Gids: + name: gids + in: query + description: 'A comma-separated list of group IDs. + + If there is not at least one resource that matches + + each of the elements of `gids`, then an error is returned. + + This cannot be provided together with `group_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + Group_names: + name: group_names + in: query + description: 'A comma-separated list of group names. + + If there is not at least one resource that matches + + each of the elements of `group_names`, then an error is returned. + + This cannot be provided together with `gids` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Uids: + name: uids + in: query + description: 'A comma-separated list of user IDs. + + If there is not at least one resource that matches + + each of the elements of `uids`, then an error is returned. + + This cannot be provided together with `user_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: integer + format: int32 + User_names: + name: user_names + in: query + description: 'A comma-separated list of user names. + + If there is not at least one resource that matches + + each of the elements of `user_names`, then an error is returned. + + This cannot be provided together with `uids` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + 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 + Without_default_access_list: + name: without_default_access_list + in: query + description: 'Specifying this option ensures a realm is created without any + resource accesses. + + ' + required: true + schema: + type: boolean + Realm_ids: + name: realm_ids + in: query + description: 'A comma-separated list of realm 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 + + `realm_names` query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Realm_names: + name: realm_names + in: query + description: 'A comma-separated list of realm names. If there is not + + at least one resource that matches each of the elements, then an error + + is returned. This cannot be provided together with `realm_ids` + + query parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Resiliency_group_ids: + name: resiliency_group_ids + in: query + description: 'A comma-separated list of resiliency group IDs. + + If there is not at least one resource that matches each of the + + elements of `resiliency_group_ids`, then an error is returned. + + This cannot be provided in conjunction with the `resiliency_group_names` parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Resiliency_group_names: + name: resiliency_group_names + in: query + description: 'A comma-separated list of resiliency group names. + + If there is not at least one resource that matches each of the + + elements of `resiliency_group_names`, then an error is returned. + + This cannot be provided in conjunction with the `resiliency_group_ids` parameter. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Limit_scale: + name: limit + in: query + description: 'Limit the size of the response to the specified number of resources. + + A `limit` of `0` can be used to get the number of resources without getting + + all of the resources. It will be returned in the `total_item_count` field. + + If a client asks for a page size larger than the available number, the request + + is still valid. In that case the server just returns the available number + of + + items, disregarding the client''s page size request. + + If the page size requested is larger than the system maximum limit, + + the server returns the maximum limit, disregarding the requested page size. + + If there are additional items `more_items_remaining` will be set to true. + + Additional items can be fetched using the `offset` or `continuation_token` + query + + params. + + ' + schema: + type: integer + format: int32 + minimum: 0 + example: 10 + Create_ds: + name: create_ds + in: query + description: 'The name of the directory service object to create used for NFS + access to this server. + + The name must be the server `name` followed by _nfs. + + ' + required: true + schema: + type: string + example: server1_nfs + Cascade_delete: + name: cascade_delete + in: query + description: 'The resource types to delete when deleting this object. It will + fail if the resources are + + referenced by other objects. + + Valid values include `directory-services`. + + ' + required: true + style: form + explode: false + schema: + type: array + items: + type: string + example: directory-services + 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 + Analysis_period_end_time: + name: analysis_period_end_time + in: query + description: 'When the analysis time window ends (in milliseconds since epoch). + + ' + schema: + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + Analysis_period_start_time: + name: analysis_period_start_time + in: query + description: 'When the analysis time window starts (in milliseconds since epoch). + + ' + schema: + type: integer + format: int64 + minimum: 0 + example: 1514764800000 + 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_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 + Names_for_syslog: + name: names + in: query + description: 'Performs the operation on the unique name specified. + + Enter multiple names in comma-separated format. + + For example, `name01,name02`. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Effective_tls_policy: + name: effective + in: query + description: 'If `true`, then the TLS policies returned will be fully evaluated. + This + + involves expanding shortened TLS ciphers, removing disabled TLS ciphers from + + the list of expanded enabled TLS ciphers, and converting values such as + + `default` and `legacy` into concrete values, in order to return the discrete + + effective TLS settings that the policies encode. + + Defaults to `false`. + + ' + schema: + type: boolean + Purity_defined: + name: purity_defined + in: query + description: 'If `true`, then the results returned will be include the specification + + for purity-defined values on the current purity version. These values + + may be used in configurations in order to dynamically adopt new behavior + + across upgrades, and this option allows the exact behavior for the current + + version to be returned. + + Defaults to `false`. + + ' + schema: + type: boolean + 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 + Namespaces: + name: namespaces + in: query + description: 'A comma-separated list of namespaces. + + ' + 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 + Keys: + name: keys + in: query + description: 'A comma-separated list of tag keys. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + Namespaces_delete: + name: namespaces + in: query + description: 'A comma-separated list of namespaces. Only one namespace is allowed + per delete request. + + ' + style: form + explode: false + schema: + type: array + items: + type: string + responses: + OauthToken200: + description: OK + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + 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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + 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 + headers: + X-Request-ID: + description: Supplied by client during request or generated by server. + schema: + type: string + content: + application/json: + schema: + type: object + properties: + error: + type: string + example: invalid_client + error_description: + type: string + example: 'Invalid identity: JWT validation failed.' +tags: +- name: Auth Helpers + description: A set of endpoints not in the Purity API, but to make OAuth using this + tool simple and easy to understand. +- 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 joins a server to the domain and manages + its computer account. Authentication for NFS or SMB is performed using Kerberos. + This configuration is also used to authorize users by mapping identities across + the NFS and SMB protocols by using LDAP queries. +- name: Administrators + description: Manage administrators, including their REST API Token and public key + for SSH access. The array has a single default administrative account named `pureuser`. + Additional administrators and their administrative roles can be added by configuring + the `management` directory service for the array or by creating local administrative + users. The available administrative roles are `array_admin`, `storage_admin`,`readonly`, + `ops_admin`. +- name: Alerts + description: Alerts indicate significant events that occur on the 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: Arrays + description: Arrays features provide the ability to configure settings that affect + the array as a whole, monitor array I/O performance, and make sure that the array + is operating properly. +- name: Array Connections + description: View and manage connected arrays, including their network configurations, + connection keys, and replication performance. +- name: Audits + description: View the audit trail on the array. Every request that creates, modifies, + or deletes a resource will be logged in the audit trail. +- name: Blades + description: Displays the detailed information of each blade in the array. +- name: Buckets + description: Manages the creation, attributes, and deletion of buckets on the array. +- name: Bucket Replica Links + description: Object replication requires a replica link that connects a source bucket + to a remote bucket. The configuration of a replica link includes remote credentials, + bucket names, remote names, replication status information, and cascading state. +- name: Certificates + description: Purity//FB 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 can contain one or more CA certificates for verifying + an LDAP server identity and establish communication over TLS. +- name: Clients + description: "Displays an NFS client\u2019s performance metrics on the array for + read, write, and meta operations." +- 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: DNS + description: Manages the Domain Name System (DNS) attributes, including the domain + suffix and static name servers. The configured attributes can be listed. +- name: Drives + description: Displays detailed information for each drive in the array. Drives are + not used in all hardware platforms, and are currently only present in the FlashBlade//S + and FlashBlade//E product lines. +- name: File Systems + description: Manages the creation, attributes, and deletion of file systems on the + array. +- name: File System Exports + description: Manages the creation, attributes, and deletion of file system exports. + Exports link either an NFS Export Policy or a SMB Client Policy, a file system, + and a server. +- name: File System Replica Links + description: File system replication requires a replica link that connects a source + array to a remote target. The configuration of a replica link includes policies, + file system names, remote names, and replication status information. +- name: File System Snapshots + description: A file system snapshot is a point-in-time copy of a file system. Multiple + snapshots of a file system can be copied for different points in time. A snapshot + policy can also be applied to a file system for automatic creation and retention + of snapshots. Additionally, file system snapshots can also be sent from one array + to another. +- name: Fleets + description: A fleet is a collection of Regions, Availability Zones, and Arrays. +- name: Hardware + description: Manages hardware components. List information about array hardware + components that are capable of reporting their status. The display is primarily + useful for diagnosing hardware-related problems. +- name: Hardware Connectors + description: 'The endpoints are deprecated. Use the endpoints under Network Interfaces + instead. + + Manages the port connector attributes on the array. Lane speeds + + and port count attributes can be configured. + + ' +- name: Keytabs + description: Keytab management functionality for Kerberos authentication. +- name: KMIP + description: Manages KMIP server configurations and performs connectivity and functionality + tests. +- name: Legal Holds + description: Manages the creation, attributes, and deletion of holds on the array. + A hold can be also applied to a path under a file system to mark the entries under + the path as immutable. +- 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: Link Aggregation Groups + description: Manages the link aggregation group (LAG) of Ethernet ports on the array. +- name: Logs + description: The array collects a log of command activities that can be used for + analysis when the logs are sent to Pure Technical Services. +- name: Maintenance Windows + description: 'During a maintenance window, many alerts are suppressed that are related + to connections, + + paths, ports, and other resources that are down during maintenance. + + ' +- name: Network Interfaces + description: Manages the interface, network connection, and port connector attributes + of the array. Lane speeds and port count connector attributes can be configured. +- name: Nodes + description: Manages the nodes for pNFS. These nodes are where the client will read/write + to when pNFS is enabled. +- name: Node Groups + description: Node Groups can contain one or more nodes for file system creation + management. +- 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 Account Exports + description: Manages object store account exports. Exports expose accounts and their + contained resources to servers. +- name: Object Store Remote Credentials + description: Manages remote credentials for remote objects. Remote credentials contain + access information that can be reused for multiple objects. +- name: Object Store Roles + description: Manages the roles assumable by external federated entity. Each role + is assigned a trust policy that determines which identity provider authorizes + the entities and how. +- 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: OIDC SSO + description: 'OIDC SSO allows customers to configure settings of OIDC service provider + + and identity provider. It provides a multi-factor authentication (MFA) + + mechanism for customers to log in to FlashBlade. + + ' +- name: Policies (All) + description: Displays general information for all available types of policies and + their members. +- name: Policies - Audit for File Systems + description: Manages audit policies for filesystems. These policies are composed + of log target rules which contain the destination for audit logs. +- name: Policies - Data Eviction + description: Manages file Data Eviction policies. These policies define controls + that can be configured and attached to managed data lifecycle independently of + the lifecycle of files. +- name: Policies - Management Access + description: Manages management access policies. These policies are composed of + rules which govern an administrative user's permissions when managing resources. +- name: Policies - Management Authentication + description: Manages management authentication policies. These policies control + what authentication factors are required when logging in to different management + interfaces (e.g., SSH). +- name: Policies - Network Access + description: Manages network access policies. These policies are composed of rules + which govern a client's ability to access different product interfaces. +- name: Policies - NFS + description: Manages NFS export policies. These policies are composed of rules which + govern a client's ability to access the exported filesystem. +- name: Policies - Object Store Access + description: Manages access policies for object store users. Administrators can + assign policies to users for managing buckets and objects. +- name: Policies - Password + description: Manages password policies. These policies define requirements for user + passwords complexity and login attempts. +- name: Policies - QoS + description: Manages Quality of Service (QoS) policies. These policies define controls + that can be configured and attached to managed objects to guarantee performance + of workloads. +- name: Policies - S3 Export + description: 'Manages S3 export policies for Object Store Account Exports. These + policies contain rules which + + govern which buckets from the account are actually exported to the servers. + + ' +- name: Policies - SMB Client + description: An SMB Client policy manages access to SMB file systems on a per-client + basis. These policies can be applied to one or more file systems. +- name: Policies - SMB Share + description: An SMB Share policy manages access to SMB file systems on a per-user/group + basis. These policies can be applied to one or more file systems. +- name: Policies - Snapshot + description: A snapshot policy manages the creation file system snapshots or it + can applied to file system and object replication links for replication. These + policies provide the user a way to control the frequency of creating snapshots + and objects, and the retention time for each copy. A snapshot policy can be applied + to one or more file systems, objects, or replication links. +- name: Policies - SSH Certificate Authority + description: An SSH Certificate Authority policy manages the keys that are allowed + to sign user SSH certificates for access to the array, as well as the principals + that they require be encoded in certificates to authenticate. These policies can + be applied to one or more users, or as a default for all users. +- name: Policies - Storage Class Tiering + description: A storage class tiering policy manages the criteria for tiering data + within a filesystem from one storage class to another. These policies can be applied + to one or more filesystems. Supported storage classes are `S500X-S` for speed, + and `S500X-A` for archival. +- name: Policies - TLS + description: A TLS policy manages the allowed TLS versions and ciphers for incoming + network traffic to the system. These policies can be applied at the array level, + or to individual network IPs. +- name: Policies - WORM Data + description: Manages WORM data for file systems. These policies are composed of + retention periods, lock type, and auto-commit status. +- name: Presets + description: 'Presets are reusable templates that provision resources. + + ' +- name: Public Keys + description: Public Keys can be configured for reference in other configurations + as signing keys are used to verify cryptographic signatures. +- name: Quotas + description: A quota manages a set amount of space on a file system which a user + or group may write to. A quota can be applied to a user or group of a specified + file system. Once a user or group reaches their quota they will no longer be able + to write to that file system. +- name: Realms + description: 'A realm provides a means to compartmentalize storage resources, + + access, and isolate administration of all contained resources. + + ' +- name: Remote Arrays + description: 'Remote arrays provide the ability to list and manage all the remote + arrays known to an array. + + ' +- name: Resiliency Groups + description: 'Resiliency groups display pairs of nodes where HA is enabled. + + ' +- name: Resource Accesses + description: 'Resource Access captures sharing of a resource to a scope, e.g. sharing + a dns to a realm. + + ' +- name: RDL + description: Displays Rapid Data Locking (RDL) configuration and performs functionality + tests of the associated Enterprise Key Management (EKM) servers. +- name: Roles + description: Displays role attributes. Each user of the array is assigned to a role + and each role has a set of role based access controls (RBAC). The roles (`array_admin`, + `storage_admin`, `ops_admin`, `readonly`, and `Invalid - multiple roles`) have + a specified set of permissions that allow certain actions to be performed on the + array. Each role includes a listing REST actions allowable for each endpoint. +- 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 FlashBlade. + + ' +- name: Servers + description: Manages the properties of servers. Servers are network and identity + management access points for data. +- name: Sessions + description: Displays Purity//FB login and user session data. +- 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 the Simple Network Management Protocol (SNMP) agents and displays + the Management Information Base (MIB) file. The SNMP agent sends array component + status information and alerts to the SNMP manager. The MIB file lists all manageable + modules of the array. +- name: SNMP Managers + description: Manages the Simple Network Management Protocol (SNMP) managers, including + performing functionality tests. The SNMP manager receives array component status + information and alerts from the SNMP agent. +- 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: Support + description: Manages support configurations for the array, including performing + functionality tests. The remote assist and phone home feature provides supplement + information to Pure Technical Services to assist with customer issues. +- name: Support Diagnostics + description: Manages support diagnostics for the array, including performing diagnostics + tasks, running tests, finding problems and giving remediation. The diagnostics + tool provides a way to test the array components and generate a report of the + results. +- name: Syslog + description: Manages syslog servers connected to the array, including performing + functionality tests of syslog servers. +- name: Targets + description: Manages targets for replication, including viewing the performance + metrics of active replication operations. +- name: Trust Policies + description: Manages policies that control assuming Object Store Roles by external + federated entities via Identity Providers +- name: Usage + description: Displays the data usage and hard limit quotas for all users and groups + on a file system. +- name: Verification Keys + description: Verification keys used by Pure Support to access the array. +- 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. + + '