openapi: 3.0.1 info: title: FlashArray REST Active Directory Buckets API version: '2.52' description: 'Active Directory configuration authenticates users for NFS using Kerberos or SMB using Kerberos or New Technology LAN Manager (NTLM). Active Directory is also used to authorize users by mapping identities across the NFS and SMB protocols by using LDAP queries. ' servers: - url: / tags: - name: Buckets description: Manages the creation, attributes, and deletion of buckets on the array. paths: /api/2.52/buckets: get: tags: - Buckets summary: Pure Storage GET Buckets description: List object store bucket attributes such as creation time and space usage. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BucketGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/BucketGetResponse' post: tags: - Buckets summary: Pure Storage POST Buckets description: Create a new object store bucket. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' requestBody: content: application/json: schema: $ref: '#/components/schemas/_bucketPostBase' required: true x-codegen-request-body-name: bucket responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BucketResponse' x-codegen-request-body-name: bucket delete: tags: - Buckets summary: Pure Storage DELETE Buckets description: Delete object store buckets. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} patch: tags: - Buckets summary: Pure Storage PATCH Buckets description: Modify object store bucket attributes such as destroyed and versioning. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/_bucketPatchBase' required: true x-codegen-request-body-name: bucket responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/BucketResponse' x-codegen-request-body-name: bucket /api/2.52/buckets/space: get: tags: - Buckets summary: Pure Storage List Bucket Space Information description: 'The monitoring interface or dataset that provides `physical storage` `consumption` data for each individual `bucket`. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceBucketSpaceGetResponse' '207': description: 'The status indicating a partial success. While some `resources` were successfully returned, specific `errors` occurred during the operation that may have prevented the full set of requested data from being retrieved. ' content: application/json: schema: $ref: '#/components/schemas/ResourceBucketSpaceGetResponse' /api/2.52/buckets/performance: get: x-pure-block-remote-execution: true tags: - Buckets summary: Pure Storage List Bucket Performance Data description: 'The monitoring interface that provides real-time and historical performance data, including `latency` and average `I/O` sizes. These metrics are available for each individual `bucket` and as an aggregate total for all buckets across the entire `array`. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/BucketPerformanceGetResponse' /api/2.26/bucket-audit-filter-actions: get: tags: - Buckets summary: Pure Storage 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_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string 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.26/buckets: get: tags: - Buckets summary: Pure Storage GET Buckets description: List object store bucket attributes such as creation time and space usage. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Destroyed' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Sort_2' - $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_2' '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_2' post: tags: - Buckets summary: Pure Storage POST Buckets description: Create a new object store bucket. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required_2' 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: Pure Storage DELETE Buckets description: Delete object store buckets. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Names' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} patch: tags: - Buckets summary: Pure Storage PATCH Buckets description: Modify object store bucket attributes such as destroyed and versioning. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Cancel_storage_class_transition' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids_2' - $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.26/buckets/audit-filters: get: tags: - Buckets summary: Pure Storage 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_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string 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: Pure Storage 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_2' 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: Pure Storage 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: Pure Storage 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_2' 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.26/buckets/cross-origin-resource-sharing-policies: get: tags: - Buckets summary: Pure Storage 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_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string 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: Pure Storage 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: Pure Storage 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.26/buckets/cross-origin-resource-sharing-policies/rules: get: tags: - Buckets summary: Pure Storage 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_2' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string 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: Pure Storage 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_2' - $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: Pure Storage 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.26/buckets/performance: get: tags: - Buckets summary: Pure Storage 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_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Sort_2' - $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_2' /api/2.26/buckets/bucket-access-policies: get: tags: - Buckets summary: Pure Storage 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_2' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string 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: Pure Storage 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: Pure Storage 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.26/buckets/bucket-access-policies/rules: get: tags: - Buckets summary: Pure Storage 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_2' - $ref: '#/components/parameters/Policy_names' - $ref: '#/components/parameters/Sort_2' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string 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: Pure Storage 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_2' - $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: Pure Storage 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.26/buckets/s3-specific-performance: get: tags: - Buckets summary: Pure Storage 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_2' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset_2' - $ref: '#/components/parameters/Resolution' - $ref: '#/components/parameters/Sort_2' - $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/1.5/buckets: get: tags: - Buckets summary: Pure Storage Get Buckets description: 'Retrieves buckets. ' parameters: - $ref: '#/components/parameters/Authorization_2' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Continuation_token_2' - $ref: '#/components/parameters/Filter_2' - $ref: '#/components/parameters/Ids_3' - $ref: '#/components/parameters/Limit_2' - $ref: '#/components/parameters/Names_2' - $ref: '#/components/parameters/Offset_3' - $ref: '#/components/parameters/Sort_3' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: integer X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: integer X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: integer X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/BucketGetResponse_3' '400': $ref: '#/components/responses/Error400' '403': $ref: '#/components/responses/Error403' '404': $ref: '#/components/responses/Error404' '429': $ref: '#/components/responses/Error429' '500': $ref: '#/components/responses/Error500' components: schemas: _builtInNoId: type: object properties: name: description: Name of the object (e.g., a file system or snapshot). type: string readOnly: true 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_2' _builtIn_2: 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 BucketAccessPolicyRuleBulkManage: allOf: - $ref: '#/components/schemas/BucketAccessPolicyRulePost' - type: object properties: name: description: Name of the object (e.g., a file system or snapshot). type: string CrossOriginResourceSharingPolicyRuleBulkManage: allOf: - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRulePost' - type: object properties: name: description: Name of the object (e.g., a file system or snapshot). type: string BucketAccessPolicyPost: type: object properties: rules: type: array items: $ref: '#/components/schemas/BucketAccessPolicyRuleBulkManage' _timeAware: type: object properties: _as_of: description: The freshness of the data (timestamp in millis since epoch). type: integer format: int64 readOnly: true example: 1502729489760 ErrorNoContext: type: object properties: message: type: string example: Something was wrong ResourceBucketSpace: allOf: - $ref: '#/components/schemas/ResourceSpace' - type: object properties: account: $ref: '#/components/schemas/_fixedReferenceWithType' object_count: description: The count of objects within the bucket. type: integer format: int64 readOnly: true example: 42 CrossOriginResourceSharingPolicyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyResponse' BucketGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/BucketResponse' - type: object properties: total: description: 'If `total_only` query param is `true`, then this field will be a total of all records after filtering and no items will be returned. If `total_only` is `false`, then it will be a total of all records on this page. ' type: object items: $ref: '#/components/schemas/Bucket' _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`, `policies/snapshot`, etc. ' type: string x-aliases: - _reference BucketAuditFilterActionResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/BucketAuditFilterActionWithContext' BucketPerformanceItems: allOf: - $ref: '#/components/schemas/_builtIn_2' - 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 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 BucketAccessPolicyRuleGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - $ref: '#/components/schemas/BucketAccessPolicyRuleResponse' CrossOriginResourceSharingPolicyRule: allOf: - $ref: '#/components/schemas/_context_2' - $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_2' _builtIn: description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support settings). Some correspond to a piece of software, like an app, or hardware, like a controller. Others are created by the system in response to some event (e.g., alerts, audit records). Typically, a user can''t create, delete or rename a built-in resource. A few can be created or deleted, but not renamed because the names are meaningful to Purity (e.g., VIFs). ' type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. ' type: string readOnly: true name: description: 'A locally unique, system-generated name. The name cannot be modified. ' type: string readOnly: true _bucketPatchBase: type: object properties: destroyed: description: 'If set to `true`, the bucket is destroyed. If set to `false`, the bucket is recovered. ' type: boolean example: true versioning: description: 'The versioning state for objects within the bucket. Valid values are `enabled` and `suspended`. ' type: string example: enabled BucketAccessPolicyRuleResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/BucketAccessPolicyRuleWithContext' _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 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 Bucket_2: allOf: - $ref: '#/components/schemas/_builtIn_2' - $ref: '#/components/schemas/_context_2' - type: object properties: account: $ref: '#/components/schemas/_fixedReference_2' 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_2' 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_2' 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 _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 PageInfo_3: type: object properties: continuation_token: description: 'Continuation token that can be provided in the continuation_token query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string example: MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My total_item_count: description: Total number of items after applying filter params. type: integer format: int32 example: 1 _resource_2: description: 'An ordinary (as opposed to built-in) resource that can be created, named, renamed, or deleted by the user. This might be a virtual resource (e.g., a volume), or correspond to something in the physical environment, like a host or a server. ' allOf: - $ref: '#/components/schemas/_timeAware' - type: object properties: id: description: A non-modifiable, globally unique ID chosen by the system. type: string readOnly: true example: 2a989a09-c851-4d52-9ec6-ab728b1c04db name: description: A modifiable, locally unique name chosen by the user. type: string example: example_name Bucket_3: allOf: - $ref: '#/components/schemas/_arraysResource' - type: object properties: account: $ref: '#/components/schemas/_fixedReference_3' created: description: Creation time of the bucket, in milliseconds since Unix epoch. type: integer format: int64 readOnly: true example: 1502729489760 destroyed: description: 'Returns a value of `true` if the bucket is destroyed, but not yet eradicated. ' type: boolean object_count: description: The number of objects contained within the bucket. type: integer format: int64 readOnly: true example: 15 versioning: description: 'The versioning state for objects within the bucket. Valid values are `none`, `enabled`, and `suspended`. ' type: string BucketAuditFilterPost: description: The audit filter object. allOf: - $ref: '#/components/schemas/BucketAuditFilterBase' _space: type: object properties: data_reduction: description: 'The ratio of mapped sectors within a volume versus the amount of physical space the data occupies after data compression and deduplication. The data reduction ratio does not include thin provisioning savings. For example, a data reduction ratio of 5:1 means that for every 5 MB the host writes to the array, 1 MB is stored on the array''s flash modules. ' type: number format: float readOnly: true footprint: description: 'The maximum amount of physical space the container consumes on an array, ignoring any data shared outside the container, measured in bytes. On Evergreen//One arrays, this is the maximum amount of effective used space. The footprint metric is mostly used for capacity planning. This field will be null in non-container contexts. ' type: integer format: int64 minimum: 0 readOnly: true shared: description: 'The physical space occupied by deduplicated data, meaning that the space is shared with other volumes and snapshots as a result of data deduplication. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data that is not unique to a specific volume, managed directory, or snapshot, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true example: 111863360624 snapshots: description: 'The physical space occupied by data unique to one or more snapshots. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by data unique to one or more snapshots, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true system: description: 'The physical space occupied by internal array metadata. Measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true thin_provisioning: description: 'The percentage of volume sectors that do not contain host-written data because the hosts have not written data to them or the sectors have been explicitly trimmed. ' type: number format: float minimum: 0 maximum: 1 readOnly: true total_physical: description: 'This field has been deprecated. Use the `total_used` field, as it contains the same information. ' type: integer format: int64 minimum: 0 readOnly: true total_provisioned: description: 'The provisioned size of a volume for a single volume, host or host group, protocol endpoint, managed directory, and containers can be infinite or measured in bytes. Infinite is represented by `null`. The provisioned size for a host or host group, includes all volumes that are connected to the resource. The provisioned size for a protocol endpoint is `null`. The provisioned size for a managed directory is the quota limit if it or its parent has a managed directory configured, otherwise it defaults to `null`. The provisioned size for a container is the sum of the total_provisioned of the object it contains, capped by the container''s quota limit (or the container''s used_provisioned if current usage is above the quota limit), if any. Provisioned size represents the storage capacity reported to hosts. ' type: integer format: int64 minimum: 0 readOnly: true example: 19937690345472 total_reduction: description: 'The ratio of provisioned sectors within a volume versus the amount of physical space the data occupies after reduction via data compression and deduplication and with thin provisioning savings. Total reduction is data reduction with thin provisioning savings. For example, a total reduction ratio of 10:1 means that for every 10 MB of provisioned space, 1 MB is stored on the array''s flash modules. ' type: number format: float readOnly: true total_used: description: 'The total space contributed by customer data, measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true unique: description: 'The unique physical space occupied by customer data. Unique physical space does not include shared space, snapshots, and internal array metadata. Measured in bytes. On Evergreen//One arrays, this is the effective space contributed by unique customer data, measured in bytes. Unique data does not include shared space, snapshots, and internal array metadata. ' type: integer format: int64 minimum: 0 readOnly: true used_provisioned: description: 'The amount of logical space a container has consumed, compared against the quota limit if the container has one configured. Used provisioned does not include destroyed objects inside the container. Used provisioned can include destroyed objects for a destroyed container and represents how much logical space it would take to recover the container. ' type: integer format: int64 minimum: 0 readOnly: true example: 19937690345472 virtual: description: 'The amount of logically written data that a volume or a snapshot references. Measured in bytes. ' type: integer format: int64 minimum: 0 readOnly: true _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 BucketAuditFilterResponse: type: object properties: items: description: A list of audit filters. type: array items: $ref: '#/components/schemas/BucketAuditFilterWithContext' _errorErrors: type: object properties: context: type: string example: Error with ... message: type: string example: Something was wrong PolicyBase: allOf: - $ref: '#/components/schemas/PolicyBaseRenameable' _resource: description: 'An ordinary (as opposed to built-in) resource that can be created, named, renamed or deleted by the user. This might be a virtual resource (e.g., a file system), or correspond to something in the environment, like a host or a server. ' type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified and cannot refer to another resource. ' type: string readOnly: true name: description: 'A user-specified name. The name must be locally unique and can be changed. ' type: string _arrays: type: object properties: arrays: description: 'The list of arrays where this resource exists. Many resources are on a single array, but some resources, such as pods, can be shared across multiple arrays. ' type: array readOnly: true items: $ref: '#/components/schemas/_fixedReferenceFqdn' x-readOnly: true _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' BucketAuditFilterWithContext: allOf: - $ref: '#/components/schemas/_context_2' - $ref: '#/components/schemas/BucketAuditFilter' _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 _fixedReferenceFqdn: allOf: - $ref: '#/components/schemas/_fixedReference_3' - type: object properties: fqdn: description: 'The fully qualified domain name of the appliance when `resource_type` is `arrays`, `null` otherwise. ' type: string readOnly: true example: example_name.dc1.example.com _fixedReference_2: 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 CrossOriginResourceSharingPolicyResponse: type: object properties: items: description: A list of cross origin resource sharing policy objects. type: array items: $ref: '#/components/schemas/CrossOriginResourceSharingPolicy' BucketAuditFilterActionWithContext: allOf: - $ref: '#/components/schemas/_context_2' - $ref: '#/components/schemas/BucketAuditFilterAction' _arraysResource: description: 'A built-in resource that exists on one or multiple arrays. ' allOf: - $ref: '#/components/schemas/_resource_2' - $ref: '#/components/schemas/_arrays' Bucket: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_bucketBase' - type: object description: 'The bucket in the object store. A bucket is a container for objects. ' properties: space: description: The size and space consumption details. title: Space allOf: - $ref: '#/components/schemas/_space' CrossOriginResourceSharingPolicyRuleGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleResponse' PageInfo: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the continuation token to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The continuation token is generated if the limit is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string more_items_remaining: description: 'Returns a value of `true` if subsequent items can be retrieved. ' type: boolean example: false total_item_count: description: 'The total number of records after applying all filter query parameters. The `total_item_count` will be calculated if and only if the corresponding query parameter `total_item_count` is set to `true`. If this query parameter is not set or set to `false`, a value of `null` will be returned. ' type: integer format: int32 _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' BucketAccessPolicyRuleWithContext: allOf: - $ref: '#/components/schemas/BucketAccessPolicyRule' - $ref: '#/components/schemas/_context_2' Error: type: object properties: errors: description: The list of errors encountered. type: array items: $ref: '#/components/schemas/_errorErrors' BucketPerformance: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_bucketPerformanceBase' _reference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string name: description: 'The resource name, such as volume name, pod name, snapshot name, and so on. ' type: string x-aliases: - _referenceWithoutType _errorcontextresponseErrors: type: object properties: context: description: 'Contains information relating to the cause of this error, or the name of the object that was being processed when the error was encountered. This may be `null` for more general errors. ' type: string location_context: description: 'Contains information relating to the context in which the request was executing when the error occurred. For example, this may be the name of an array in the same fleet. This may be `null` for more general errors, or if no explicit `context` parameter was provided with the request. ' title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' message: description: A description of the error which occurred. type: string example: Resource does not exist. x-aliases: - _errorContextResponseErrors _errorContextResponse_2: 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' _space_2: 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 CrossOriginResourceSharingPolicyPatch: type: object properties: rules: type: array items: $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleBulkManage' _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 BucketAuditFilterGetResponse: allOf: - $ref: '#/components/schemas/_errorContextResponse_2' - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/BucketAuditFilterResponse' _fixedReferenceWithType: allOf: - $ref: '#/components/schemas/_fixedReference' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are the unique part of the resource''s REST endpoint. For example, a reference to a file system would have a `resource_type` of `file-systems`. ' type: string readOnly: true x-aliases: - _fixedReference 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_2' 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/* BucketS3SpecificPerformance: allOf: - $ref: '#/components/schemas/_builtIn_2' - 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 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 CrossOriginResourceSharingPolicyRuleWithContext: allOf: - $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRule' - $ref: '#/components/schemas/_context_2' _context_2: 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_2' PolicyBaseRenameable: allOf: - $ref: '#/components/schemas/_resource' - $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_2' 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 _context: type: object properties: context: description: 'The context in which the operation was performed. Valid values include a reference to any array which is a member of the same fleet or to the fleet itself. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. ' readOnly: true title: FixedReferenceWithType allOf: - $ref: '#/components/schemas/_fixedReferenceWithType' _reference_2: 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 BucketS3SpecificPerformanceGetResp: allOf: - $ref: '#/components/schemas/PageInfo_2' - 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' 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: - '*' PageInfo_2: type: object properties: continuation_token: description: 'Continuation token that can be provided in the `continuation_token` query param to get the next page of data. If you use the `continuation_token` to page through data you are guaranteed to get all items exactly once regardless of how items are modified. If an item is added or deleted during the pagination then it may or may not be returned. The `continuation_token` is generated if the `limit` is less than the remaining number of items, and the default sort is used (no sort is specified). ' type: string total_item_count: description: Total number of items after applying `filter` params. type: integer format: int32 BucketAccessPolicyGetResponse: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - $ref: '#/components/schemas/BucketAccessPolicyResponse' 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_2' BucketPerformanceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - type: object properties: items: description: 'Performance data. If `total_only=true`, the `items` list will be empty. ' type: array items: $ref: '#/components/schemas/BucketPerformance' total: description: 'The aggregate value of all items after filtering. When it makes sense, the average value is displayed instead. The values are displayed for each field if meaningful. ' type: array items: $ref: '#/components/schemas/BucketPerformance' _fixedReference_3: type: object properties: id: description: The opaque and unique id of this resource. type: string readOnly: true example: 2a989a09-c851-4d52-9ec6-ab728b1c04db name: description: The name of this resource. type: string readOnly: true example: example_name resource_type: description: 'The type of this resource represented by the name of its REST endpoint. For example, "arrays", "network-interfaces", and "metrics". The value may be `null` if the resource is not represented. ' type: string readOnly: true example: example_resource_type x-readOnly: true _bucketBase: allOf: - $ref: '#/components/schemas/_context' - type: object description: 'The bucket in the object store. A bucket is a container for objects. ' properties: account: $ref: '#/components/schemas/_fixedReferenceWithType' created: description: The bucket creation time in milliseconds since the UNIX epoch. type: integer format: int64 readOnly: true example: 1602115200000 destroyed: description: 'Returns `true` if the bucket has been destroyed and is pending eradication. The `time_remaining` value displays the amount of time left until the destroyed bucket is permanently eradicated. Once the `time_remaining` period has elapsed, the bucket is permanently eradicated and can no longer be recovered. ' type: boolean example: false object_count: description: The count of objects within the bucket. type: integer format: int64 readOnly: true example: 42 time_remaining: description: 'The time in milliseconds before the bucket is eradicated. Returns `null` if the bucket is not destroyed. ' type: integer format: int64 readOnly: true example: 86400000 versioning: description: 'The versioning state for objects within the bucket. Valid values are `none`, `enabled`, and `suspended`. ' type: string example: enabled _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_2' message: description: A description of the error which occurred. type: string example: Resource does not exist. 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. _referenceNameOnly: type: object properties: name: type: string ResourceBucketSpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: 'Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. ' type: array items: $ref: '#/components/schemas/ResourceBucketSpace' total: description: 'The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field. ' type: array items: $ref: '#/components/schemas/ResourceBucketSpace' _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 BucketAccessPolicyResponse: type: object properties: items: description: A list of bucket policy objects. type: array items: $ref: '#/components/schemas/BucketAccessPolicy' 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 _referenceWithType: allOf: - $ref: '#/components/schemas/_reference' - type: object properties: resource_type: description: 'Type of the object (full name of the endpoint). Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`, `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`, `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and `policies/snapshot`, etc. ' type: string x-aliases: - _reference BucketResponse: type: object properties: items: description: A list of bucket objects. type: array items: $ref: '#/components/schemas/Bucket' CrossOriginResourceSharingPolicyRuleResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleWithContext' CrossOriginResourceSharingPolicy: allOf: - $ref: '#/components/schemas/PolicyBase' - $ref: '#/components/schemas/_context_2' - type: object properties: bucket: description: The bucket to which this policy belongs. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' rules: type: array maxItems: 100 items: $ref: '#/components/schemas/CrossOriginResourceSharingPolicyRuleWithContext' BucketPerformanceGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - 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_2' BucketGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/BucketResponse' - $ref: '#/components/schemas/_errorContextResponse_2' - type: object properties: total: $ref: '#/components/schemas/Bucket_2' BucketAuditFilterActionGetResponse: allOf: - $ref: '#/components/schemas/_errorContextResponse_2' - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/BucketAuditFilterActionResponse' BucketResponse_2: type: object properties: items: type: array items: $ref: '#/components/schemas/Bucket_3' BucketPerformance_2: allOf: - $ref: '#/components/schemas/_builtIn_2' - 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 ResourceSpace: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_context' - type: object properties: space: description: 'Displays size and space consumption information. ' title: Space allOf: - $ref: '#/components/schemas/_space' time: description: 'The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true x-readOnly: true _bucketPostBase: type: object properties: account: description: The name of the account for bucket creation. title: ReferenceWithType allOf: - $ref: '#/components/schemas/_referenceWithType' BucketGetResponse_3: allOf: - $ref: '#/components/schemas/PageInfo_3' - $ref: '#/components/schemas/BucketResponse_2' BucketAccessPolicy: allOf: - $ref: '#/components/schemas/PolicyBase' - $ref: '#/components/schemas/_context_2' - type: object properties: bucket: description: The bucket to which this policy belongs. title: FixedReference allOf: - $ref: '#/components/schemas/_fixedReference_2' rules: type: array items: $ref: '#/components/schemas/BucketAccessPolicyRule' _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_2' _fixedReference: type: object properties: id: description: 'A globally unique, system-generated ID. The ID cannot be modified. ' type: string readOnly: true name: description: 'The resource name, such as volume name, file system name, snapshot name, and so on. ' type: string readOnly: true x-readOnly: true x-aliases: - _fixedReferenceWithoutType _bucketPerformanceBase: type: object properties: bytes_per_op: description: 'The average size of an I/O operation. This metric is calculated as: the sum of `read bytes` and `write bytes` or the sum of `read ops` and `write ops`. ' type: number format: double minimum: 0 readOnly: true bytes_per_read: description: The average size of a read I/O operation. type: number format: double minimum: 0 readOnly: true bytes_per_write: description: The average size of a write I/O operation. type: number format: double minimum: 0 readOnly: true others_per_sec: description: The number of miscellaneous `operations` processed `per second`. type: number format: double minimum: 0 readOnly: true read_bytes_per_sec: description: The number of `bytes read` `per second`. type: number format: double minimum: 0 readOnly: true reads_per_sec: description: The number of `read requests` processed `per second`. type: number format: double minimum: 0 readOnly: true time: description: The `sample time` represented in `milliseconds` since the `UNIX epoch`. type: integer format: int64 readOnly: true usec_per_other_op: description: 'The `average time`, measured in `microseconds`, that the array takes to process `other operations`. ' type: number format: double minimum: 0 readOnly: true usec_per_read_op: description: 'The `average time`, measured in `microseconds`, that the array takes to process a `read request`. ' type: number format: double minimum: 0 readOnly: true usec_per_write_op: description: 'The `average time`, measured in `microseconds`, that the array takes to process a `write request`. ' type: number format: double minimum: 0 readOnly: true write_bytes_per_sec: description: The number of `bytes written` `per second`. type: number format: double minimum: 0 readOnly: true writes_per_sec: description: The number of `write requests` processed `per second`. type: number format: double minimum: 0 readOnly: true x-readOnly: true parameters: 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 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 Offset_2: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 example: 10 History_start_time: name: start_time in: query description: 'Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution. ' schema: type: integer format: int64 Authorization_2: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`) ' schema: type: string Ids: name: ids in: query description: "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" style: form explode: false schema: type: array items: type: string Filter_2: name: filter in: query description: 'Exclude resources that don''t match the specified criteria. Single quotes are required around all strings inside the filters. ' schema: type: string Sort: name: sort in: query description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string Allow_errors: name: allow_errors in: query description: 'If set to `true`, the API will allow the operation to continue even if there are errors. Any errors will be returned in the `errors` field of the response. If set to `false`, the operation will fail if there are any errors. ' schema: type: boolean default: false Continuation_token: name: continuation_token in: query description: 'A token used to retrieve the next page of data with some consistency guaranteed. The token is a Base64 encoded value. Set `continuation_token` to the system-generated token taken from the `x-next-token` header field of the response. A query has reached its last page when the response does not include a token. Pagination requires the `limit` and `continuation_token` query parameters. ' schema: type: string XRequestId: name: X-Request-ID in: header description: 'Supplied by client during request or generated by server. ' schema: type: string Limit_2: name: limit in: query description: 'Limit the size of the response to the specified number of resources. A limit of 0 can be used to get the number of resources without getting all of the resources. It will be returned in the total_item_count field. If a client asks for a page size larger than the maximum number, the request is still valid. In that case the server just returns the maximum number of items, disregarding the client''s page size request. If not specified, defaults to 1000. ' schema: type: integer format: int32 Limit: name: limit in: query description: 'Limits the size of the response to the specified number of objects on each page. To return the total number of resources, set `limit=0`. The total number of resources is returned as a `total_item_count` value. If the page size requested is larger than the system maximum limit, the server returns the maximum limit, disregarding the requested page size. ' schema: type: integer format: int32 minimum: 0 example: 10 Sort_2: 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 Ids_2: 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 Names_required: name: names in: query description: 'Performs the operation on the unique name specified. For example, `name01`. Enter multiple names in comma-separated format. ' required: true style: form explode: false schema: type: array items: type: string Sort_3: name: sort in: query description: 'Sort the response by the specified fields (in descending order if ''-'' is appended to the field name). If you provide a sort you will not get a continuation token in the response. ' style: form explode: false schema: type: array items: pattern: ^[a-z]+(_[a-z]+)*-? type: string 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 Total_only: name: total_only in: query description: 'If set to `true`, returns the aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. The values are displayed for each name where meaningful. If `total_only=true`, the `items` list will be empty. ' schema: type: boolean Filter: name: filter in: query description: 'Narrows down the results to only the response objects that satisfy the filter criteria. ' schema: type: string Offset: name: offset in: query description: 'The starting position based on the results of the query in relation to the full set of response objects returned. ' schema: type: integer format: int32 minimum: 0 example: 10 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 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 History_end_time: name: end_time in: query description: 'Displays historical performance data for the specified time window, where `start_time` is the beginning of the time window, and `end_time` is the end of the time window. The `start_time` and `end_time` parameters are specified in milliseconds since the UNIX epoch. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. If `end_time`is not specified, the end time will default to the current time. Include the `resolution` parameter to display the performance data at the specified resolution. If not specified, `resolution` defaults to the lowest valid resolution. ' schema: type: integer format: int64 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 Continuation_token_2: name: continuation_token in: query description: 'An opaque token used to iterate over a collection. The token to use on the next request is returned in the `continuation_token` field of the result. Single quotes are required around all strings. ' schema: type: string x-quoted: true x-quoted: true Authorization: name: Authorization in: header description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`, `/login`, and `/logout`) ' schema: type: string 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 Ids_3: name: ids in: query description: 'A comma-separated list of resource IDs. If there is not at least one resource that matches each `id` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true 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 History_resolution: name: resolution in: query description: 'The number of milliseconds between samples of historical data. For array-wide performance metrics (`/arrays/performance` endpoint), valid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For performance metrics on storage objects (`/performance` endpoint), such as volumes, valid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). For space metrics, (`/space` endpoint), valid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours). Include the `start_time` parameter to display the performance data starting at the specified start time. If `start_time` is not specified, the start time will default to one resolution before the end time, meaning that the most recent sample of performance data will be displayed. Include the `end_time` parameter to display the performance data until the specified end time. If `end_time`is not specified, the end time will default to the current time. If the `resolution` parameter is not specified but either the `start_time` or `end_time` parameter is, then `resolution` will default to the lowest valid resolution. ' schema: type: integer format: int64 minimum: 0 example: 30000 Offset_3: name: offset in: query description: 'The offset of the first resource to return from a collection. ' schema: type: integer format: int32 minimum: 0 Names_required_2: name: names in: query description: 'A comma-separated list of resource names. ' required: true style: form explode: false schema: type: array items: type: string Names_2: name: names in: query description: 'A comma-separated list of resource names. If there is not at least one resource that matches each `name` element, an error is returned. Single quotes are required around all strings. ' style: form explode: false schema: type: array items: type: string x-quoted: true x-quoted: true Names: name: names in: query description: 'Performs the operation on the unique names specified. Enter multiple names in comma-separated format. For example, `name01,name02`. If there is not at least one resource that matches each of the elements of `names`, then an error is returned, except when creating new resources. ' style: form explode: false schema: type: array items: type: string Context_names_get: name: context_names in: query description: 'Performs the operation on the unique contexts specified. If specified, each context name must be the name of an array in the same fleet or the name of the fleet itself. If not specified, the context will default to the array that received this request. Other parameters provided with the request, such as names of volumes or snapshots, are resolved relative to the provided `context`. Enter multiple names in comma-separated format. For example, `name01,name02`. ' style: form explode: false schema: type: array items: type: string 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 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 responses: Error403: description: FORBIDDEN headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object content: application/json: schema: $ref: '#/components/schemas/ErrorNoContext' Error400: description: BAD REQUEST headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error' Error429: description: TOO MANY REQUESTS headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/ErrorNoContext' Error500: description: INTERNAL SERVER ERROR headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error' Error404: description: NOT FOUND headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: object X-RateLimit-Remaining-minute: description: 'The number of requests remaining for the organization in that minute. ' schema: type: object X-RateLimit-Remaining-second: description: 'The number of requests remaining for the organization in that second. ' schema: type: object X-RateLimit-Limit-minute: description: The number of requests available per minute. schema: type: object X-RateLimit-Limit-second: description: The number of requests available per second. schema: type: object content: application/json: schema: $ref: '#/components/schemas/Error'