openapi: 3.0.1 info: title: FlashArray REST Active Directory Object Store Accounts 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: Object Store Accounts description: Manages object store accounts. Accounts contain buckets and users. Accounts must be created before an object store user or buckets can be created. paths: /api/2.52/object-store-accounts: get: tags: - Object Store Accounts summary: Pure Storage GET Object-store-accounts description: The list of object store accounts and their associated attributes. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccountGetResponse' '207': description: 'Partial success. Some resources were returned, but there were also errors possibly preventing some resources from being returned. ' content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccountGetResponse' post: tags: - Object Store Accounts summary: Pure Storage POST Object-store-accounts description: The creation of an object store account. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccountResponse' x-codegen-request-body-name: object-store-account delete: tags: - Object Store Accounts summary: Pure Storage DELETE Object-store-accounts description: The deletion of an object store account. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Names' responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: {} /api/2.52/object-store-accounts/space: get: tags: - Object Store Accounts summary: Pure Storage List Object Store Account Space Information description: 'The monitoring interface or dataset that provides `physical storage` `consumption` data for each `object store account`. ' parameters: - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/History_end_time' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids' - $ref: '#/components/parameters/Limit' - $ref: '#/components/parameters/Names' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/History_resolution' - $ref: '#/components/parameters/Sort' - $ref: '#/components/parameters/History_start_time' - $ref: '#/components/parameters/Total_item_count' - $ref: '#/components/parameters/Total_only' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceObjectStoreAccountSpaceGetResponse' '207': description: 'The status indicating a partial success. While some `resources` were successfully returned, specific `errors` occurred during the operation that may have prevented the full set of requested data from being retrieved. ' content: application/json: schema: $ref: '#/components/schemas/ResourceObjectStoreAccountSpaceGetResponse' /api/2.26/object-store-accounts: get: tags: - Object Store Accounts summary: Pure Storage GET Object-store-accounts description: List object store accounts and their attributes. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Allow_errors' - $ref: '#/components/parameters/Context_names_get' - $ref: '#/components/parameters/Continuation_token' - $ref: '#/components/parameters/Filter' - $ref: '#/components/parameters/Ids_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/ObjectStoreAccountGetResponse_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/ObjectStoreAccountGetResponse_2' post: tags: - Object Store Accounts summary: Pure Storage POST Object-store-accounts description: 'Create an object store account. ' parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Names_required_2' requestBody: content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccountPost' required: false x-codegen-request-body-name: object-store-account responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccountResponse' x-codegen-request-body-name: object-store-account delete: tags: - Object Store Accounts summary: Pure Storage DELETE Object-store-accounts description: Delete an object store account. 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: - Object Store Accounts summary: Pure Storage PATCH Object-store-accounts description: Modify object store account attributes such as quota limit and bucket defaults. parameters: - $ref: '#/components/parameters/XRequestId' - $ref: '#/components/parameters/Context_names' - $ref: '#/components/parameters/Ids_2' - $ref: '#/components/parameters/Ignore_usage' - $ref: '#/components/parameters/Names' requestBody: content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccountPatch' required: true x-codegen-request-body-name: object-store-account responses: '200': description: OK headers: X-Request-ID: description: Supplied by client during request or generated by server. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ObjectStoreAccountResponse' x-codegen-request-body-name: object-store-account /api/1.5/object-store-accounts: get: tags: - Object Store Accounts summary: Pure Storage Get Object Store Accounts description: 'Retrieves object store accounts. ' 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/ObjectStoreAccountGetResponse_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: _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 _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 ObjectStoreAccountPost: type: object properties: account_exports: description: 'A list of exports to be created for the account. If ommited or set to `null`, the default server for object store will be used. Use `[]` to create an account without any export. ' type: array items: title: ServerForAccountExport allOf: - $ref: '#/components/schemas/_serverForAccountExport' bucket_defaults: description: 'Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields. ' title: BucketDefaults allOf: - $ref: '#/components/schemas/_bucketDefaults' hard_limit_enabled: description: 'If set to `true`, the account''s size, as defined by `quota_limit`, is used as a hard limit quota. If set to `false`, a hard limit quota will not be applied to the account, but soft quota alerts will still be sent if the account has a value set for `quota_limit`. If not specified, defaults to `false`. ' type: boolean quota_limit: description: 'The effective quota limit to be applied against the size of the account, displayed in bytes. If set to an empty string (`""`), the account is unlimited in size. If not specified, defaults to unlimited. ' type: string ResourceObjectStoreAccountSpaceGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - type: object properties: items: description: 'Displays a list of all items after filtering. If applicable, the values are displayed for each name. If `total_only=true`, the `items` list will be empty. ' type: array items: $ref: '#/components/schemas/ResourceObjectStoreAccountSpace' total: description: 'The aggregate value of all items after filtering. Where it makes more sense, the average value is displayed instead. If applicable, the values are displayed for each field. ' type: array items: $ref: '#/components/schemas/ResourceObjectStoreAccountSpace' ObjectStoreAccountGetResponse_2: allOf: - $ref: '#/components/schemas/PageInfo_2' - $ref: '#/components/schemas/_errorContextResponse_2' - $ref: '#/components/schemas/ObjectStoreAccountResponse' - type: object properties: total: description: 'If `total_only` query param is `true`, then this field will be a total of all records after filtering and no items will be returned. If `total_only` is `false`, then it will be a total of all records on this page. ' title: ObjectStoreAccount allOf: - $ref: '#/components/schemas/ObjectStoreAccount_2' ObjectStoreAccount: allOf: - $ref: '#/components/schemas/_builtIn' - $ref: '#/components/schemas/_objectStoreAccountBase' - type: object description: 'The object store account is a logical container for buckets, users, and other object store entities and resources. It provides a namespace for storing and managing these objects, allowing users to organize and access their data efficiently. ' properties: space: description: 'The size and space consumption details. ' title: Space allOf: - $ref: '#/components/schemas/_space' _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 ObjectStoreAccountGetResponse_3: allOf: - $ref: '#/components/schemas/PageInfo_3' - $ref: '#/components/schemas/ObjectStoreAccountResponse_2' ObjectStoreAccount_2: allOf: - $ref: '#/components/schemas/_builtIn_2' - $ref: '#/components/schemas/_context_2' - type: object properties: bucket_defaults: description: 'Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields. ' title: BucketDefaultsReadonly allOf: - $ref: '#/components/schemas/_bucketDefaultsReadonly' created: description: Creation timestamp of the object. type: integer format: int64 readOnly: true hard_limit_enabled: description: 'If set to `true`, the account''s size, as defined by `quota_limit`, is used as a hard limit quota. If set to `false`, a hard limit quota will not be applied to the account, but soft quota alerts will still be sent if the account has a value set for `quota_limit`. ' type: boolean object_count: description: The count of objects within the account. type: integer format: int64 readOnly: true public_access_config: $ref: '#/components/schemas/_publicAccessConfig' quota_limit: description: 'The effective quota limit applied against the size of the account, displayed in bytes. If unset, the account is unlimited in size. ' type: integer realms: description: 'The realms containing this account. ' type: array readOnly: true items: $ref: '#/components/schemas/_fixedReference_2' space: description: The space specification of the object store account. title: Space allOf: - $ref: '#/components/schemas/_space_2' 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 _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 ResourceObjectStoreAccountSpace: allOf: - $ref: '#/components/schemas/ResourceSpace' - type: object properties: object_count: description: The count of objects within the account. type: integer format: int64 readOnly: true example: 42 _errorErrors: type: object properties: context: type: string example: Error with ... message: type: string example: Something was wrong _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 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 _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 _bucketDefaultsReadonly: type: object properties: hard_limit_enabled: description: 'The value of this field will be used to configure the `hard_limit_enabled` field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If not specified, defaults to `false`. ' type: boolean quota_limit: description: 'The value of this field will be used to configure the `quota_limit` field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If unset, the bucket default is unlimited in size. ' type: integer _bucketDefaults: type: object properties: hard_limit_enabled: description: 'The value of this field will be used to configure the `hard_limit_enabled` field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If not specified, defaults to `false`. ' type: boolean quota_limit: description: 'The value of this field will be used to configure the `quota_limit` field of newly created buckets associated with this object store account, if the bucket creation does not specify its own value. If set to an empty string (`""`), the bucket default is unlimited in size. If not specified, defaults to unlimited. ' type: string ObjectStoreAccountResponse: type: object properties: items: description: A list of object store account objects. type: array items: $ref: '#/components/schemas/ObjectStoreAccount' _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 ObjectStoreAccountGetResponse: allOf: - $ref: '#/components/schemas/PageInfo' - $ref: '#/components/schemas/_errorContextResponse' - $ref: '#/components/schemas/ObjectStoreAccountResponse' - type: object properties: total: description: 'If `total_only` query param is `true`, then this field will be a total of all records after filtering and no items will be returned. If `total_only` is `false`, then it will be a total of all records on this page. ' type: object items: $ref: '#/components/schemas/ObjectStoreAccount' _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 _serverForAccountExport: type: object properties: server: description: 'The server to which the account will be exported. ' title: ReferenceWithoutType allOf: - $ref: '#/components/schemas/_referenceWithoutType' _arraysResource: description: 'A built-in resource that exists on one or multiple arrays. ' allOf: - $ref: '#/components/schemas/_resource' - $ref: '#/components/schemas/_arrays' 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' ObjectStoreAccount_3: allOf: - $ref: '#/components/schemas/_arraysResource' - type: object properties: created: description: Creation timestamp of the object, in milliseconds since Unix epoch. type: integer format: int64 readOnly: true example: 1502729489760 object_count: description: The number of objects within the account. type: integer format: int64 readOnly: true example: 15 Error: type: object properties: errors: description: The list of errors encountered. type: array items: $ref: '#/components/schemas/_errorErrors' _objectStoreAccountBase: allOf: - $ref: '#/components/schemas/_context' - type: object description: 'The object store account. An account serves as a logical container for buckets, users, and other resources, providing a namespace for storing and managing these objects. ' properties: created: description: 'The object store account creation time in milliseconds since the UNIX epoch. ' type: integer format: int64 readOnly: true example: 1602115200000 object_count: description: The count of objects within the account. type: integer format: int64 readOnly: true example: 42 _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 _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 _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 _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' _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' ObjectStoreAccountResponse_2: type: object properties: items: description: A list of object store accounts. type: array items: $ref: '#/components/schemas/ObjectStoreAccount_3' 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 _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 _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. _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 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 ObjectStoreAccountPatch: type: object properties: bucket_defaults: description: 'Default settings to be applied to newly created buckets associated with this account. Values here will be used in bucket creation requests which do not specify their own values for corresponding fields. ' title: BucketDefaults allOf: - $ref: '#/components/schemas/_bucketDefaults' hard_limit_enabled: description: 'If set to `true`, the account''s size, as defined by `quota_limit`, is used as a hard limit quota. If set to `false`, a hard limit quota will not be applied to the account, but soft quota alerts will still be sent if the account has a value set for `quota_limit`. ' type: boolean public_access_config: $ref: '#/components/schemas/_publicAccessConfig' quota_limit: description: 'The effective quota limit to be applied against the size of the account, displayed in bytes. If set to an empty string (`""`), the account is unlimited in size. ' type: string _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 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' parameters: 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 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 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 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 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