Pure Storage

Pure Storage Realms API

A realm is an administrative domain, a data container, and a namespace for pods, hosts, and host groups.

Documentation GitHub OpenAPI

Operations 18

GET /api/2.52/realms Pure Storage List Realms

POST /api/2.52/realms Pure Storage Create Realms

DELETE /api/2.52/realms Pure Storage Delete Realms

PATCH /api/2.52/realms Pure Storage Modify Realms

GET /api/2.52/realms/performance Pure Storage List Realm Performance Data

GET /api/2.52/realms/qos Pure Storage List Realm QoS Config

GET /api/2.52/realms/space Pure Storage List Realm Space Information

GET /api/2.52/realms/tags Pure Storage List Tags

DELETE /api/2.52/realms/tags Pure Storage Delete Tags

PUT /api/2.52/realms/tags/batch Pure Storage Update Tags

GET /api/2.26/realms Pure Storage GET Realms

POST /api/2.26/realms Pure Storage POST Realms

DELETE /api/2.26/realms Pure Storage DELETE Realms

PATCH /api/2.26/realms Pure Storage PATCH Realms

GET /api/2.26/realms/defaults Pure Storage GET Realms/defaults

PATCH /api/2.26/realms/defaults Pure Storage PATCH Realms/defaults

GET /api/2.26/realms/space Pure Storage GET Realms/space

GET /api/2.26/realms/space/storage-classes Pure Storage GET Realms/space/storage-classes

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/pure-storage-realms-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: FlashArray REST Active Directory Realms 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: Realms
  description: A realm is an administrative domain, a data container, and a namespace for pods, hosts, and host groups.
paths:
  /api/2.52/realms:
    get:
      tags:
      - Realms
      summary: Pure Storage List Realms
      description: 'Displays a list of realms.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Destroyed'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmGetResponse'
        '207':
          description: 'Indicates partial success.

            Some resources were returned, but errors may have prevented other resources from being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmGetResponse'
    post:
      tags:
      - Realms
      summary: Pure Storage Create Realms
      description: 'Creates realms on the local array.

        Each realm must be given a name that is unique across the connected arrays.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names_required'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealmPost'
        required: false
        x-codegen-request-body-name: realm
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmResponse'
      x-codegen-request-body-name: realm
    delete:
      tags:
      - Realms
      summary: Pure Storage Delete Realms
      description: 'Deletes realms that have been destroyed and are pending eradication.

        Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Eradicate_contents'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - Realms
      summary: Pure Storage Modify Realms
      description: 'Modifies realm details.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Destroy_contents'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Container_ignore_usage'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealmPatch'
        required: true
        x-codegen-request-body-name: realm
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmResponse'
      x-codegen-request-body-name: realm
  /api/2.52/realms/performance:
    get:
      tags:
      - Realms
      summary: Pure Storage List Realm Performance Data
      description: 'Displays real-time and historical performance data, real-time latency data,

        and average I/O sizes across all realms,

        displayed both by realm and as a total across all realms.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Destroyed'
      - $ref: '#/components/parameters/History_end_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/History_resolution'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/History_start_time'
      - $ref: '#/components/parameters/Total_item_count'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerPerformanceGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContainerPerformanceGetResponse'
  /api/2.52/realms/qos:
    get:
      tags:
      - Realms
      summary: Pure Storage List Realm QoS Config
      description: 'Displays real-time and historical QoS configuration data for each realm.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Destroyed'
      - $ref: '#/components/parameters/History_end_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/History_resolution'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/History_start_time'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmQosGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmQosGetResponse'
  /api/2.52/realms/space:
    get:
      tags:
      - Realms
      summary: Pure Storage List Realm Space Information
      description: 'Displays provisioned size and storage consumption data for each realm on the

        local array.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Destroyed'
      - $ref: '#/components/parameters/History_end_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/History_resolution'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/History_start_time'
      - $ref: '#/components/parameters/Total_item_count'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmSpaceGetResponse'
  /api/2.52/realms/tags:
    get:
      tags:
      - Realms
      summary: Pure Storage List Tags
      description: 'Displays the list of tags.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Namespaces'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Resource_destroyed'
      - $ref: '#/components/parameters/Resource_ids'
      - $ref: '#/components/parameters/Resource_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagGetResponse'
    delete:
      tags:
      - Realms
      summary: Pure Storage Delete Tags
      description: 'Deletes specified tags.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Keys'
      - $ref: '#/components/parameters/Namespaces_delete'
      - $ref: '#/components/parameters/Resource_ids'
      - $ref: '#/components/parameters/Resource_names'
      responses:
        '200':
          description: OK
          content: {}
  /api/2.52/realms/tags/batch:
    put:
      tags:
      - Realms
      summary: Pure Storage Update Tags
      description: 'Updates or creates tags for all specified objects.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Resource_ids'
      - $ref: '#/components/parameters/Resource_names'
      requestBody:
        description: A list of tags to be created or, if already existing, updated.
        content:
          application/json:
            schema:
              maxItems: 30
              minItems: 1
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/NonCopyableTag'
        required: true
        x-codegen-request-body-name: tag
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TagResponse'
      x-codegen-request-body-name: tag
  /api/2.26/realms:
    get:
      tags:
      - Realms
      summary: Pure Storage GET Realms
      description: Displays a list of realms.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/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/RealmGetResponse_2'
    post:
      tags:
      - Realms
      summary: Pure Storage POST Realms
      description: Create a new realm.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names_required_2'
      - $ref: '#/components/parameters/Without_default_access_list'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmResponse'
    delete:
      tags:
      - Realms
      summary: Pure Storage DELETE Realms
      description: 'Deletes a realm that has been destroyed and is pending eradication.

        Eradicated realms cannot be recovered. Realms are destroyed using the PATCH method.

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids_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:
      - Realms
      summary: Pure Storage PATCH Realms
      description: Modify an existing realm's attributes, including destroying a realm.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealmPatch_2'
        required: true
        x-codegen-request-body-name: realm
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmResponse'
      x-codegen-request-body-name: realm
  /api/2.26/realms/defaults:
    get:
      tags:
      - Realms
      summary: Pure Storage GET Realms/defaults
      description: 'List of default configurations for realms.

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_errors'
      - $ref: '#/components/parameters/Context_names_get'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset_2'
      - $ref: '#/components/parameters/Realm_ids'
      - $ref: '#/components/parameters/Realm_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/RealmDefaultsGetResponse'
        '207':
          description: 'Partial success. Some resources were returned, but there

            were also errors possibly preventing some resources from

            being returned.

            '
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmDefaultsGetResponse'
    patch:
      tags:
      - Realms
      summary: Pure Storage PATCH Realms/defaults
      description: 'Modify a default configuration for a realm.

        '
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Realm_ids'
      - $ref: '#/components/parameters/Realm_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RealmDefaults'
        required: true
        x-codegen-request-body-name: default_realm_configuration
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmDefaultsResponse'
      x-codegen-request-body-name: default_realm_configuration
  /api/2.26/realms/space:
    get:
      tags:
      - Realms
      summary: Pure Storage GET Realms/space
      description: List used storage space for the realm.
      parameters:
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/End_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids_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'
      - $ref: '#/components/parameters/Type'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmSpaceGetResponse_2'
  /api/2.26/realms/space/storage-classes:
    get:
      tags:
      - Realms
      summary: Pure Storage GET Realms/space/storage-classes
      description: List used storage space for storage classes in the realm.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/End_time'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids_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/StorageClassNames'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RealmSpaceStorageClassGetResponse'
components:
  schemas:
    QosMetrics:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - $ref: '#/components/schemas/_containerQos'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          time:
            description: 'The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.

              '
            type: integer
            format: int64
            readOnly: true
        x-readOnly: true
    ContainerEradicationConfig:
      description: The status of the eradication functionality
      type: object
      properties:
        manual_eradication:
          description: 'The manual eradication status of the container.

            If `all-enabled`, the container and its contents can be eradicated.

            If `partially-disabled`, the container cannot be eradicated because the container

            contains some some entities that are eradication disabled.

            If `all-disabled`, the container and its contents cannot be eradicated.

            Values include `all-disabled`, `all-enabled`, and `partially-disabled`.

            '
          type: string
          readOnly: true
          example: all-enabled
    _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
    _quota_limit_type:
      type: integer
      format: int64
      minimum: 1048576
      maximum: 4503599627370496
    RealmQosGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/_errorContextResponse'
      - type: object
        properties:
          items:
            description: 'QoS configuration data.

              '
            type: array
            items:
              $ref: '#/components/schemas/QosMetrics'
    _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
    NonCopyableTag:
      type: object
      properties:
        key:
          description: 'Key of the tag. Supports up to 64 Unicode characters.

            '
          type: string
          example: environment
        namespace:
          description: 'Optional namespace of the tag.

            Namespace identifies the category of the tag. Omitting the namespace

            defaults to the namespace `default`. The `pure&#42;` namespaces are

            reserved for plugins and integration partners. It is recommended

            that customers avoid using reserved namespaces.

            '
          type: string
          example: default
        resource:
          $ref: '#/components/schemas/_fixedReference'
        value:
          description: 'Value of the tag. Supports up to 256 Unicode characters.

            '
          type: string
          example: staging
    RealmDefaultsGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/RealmDefaultsResponse'
      - $ref: '#/components/schemas/_errorContextResponse_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
    _space:
      type: object
      properties:
        available_provisioned:
          description: 'The amount of space left that the current object can grow before writes are stopped

            due to a hard limit quota being hit. This is total_provisioned minus the virtual space

            used for file-systems and buckets.

            For array and object store accounts it is total_provisioned minus the virtual space

            used by non-destroyed file-systems and buckets.

            '
          type: integer
          format: int64
          minimum: 0
          example: 19937690345472
        available_ratio:
          description: 'The ratio of the available space versus the total provisioned space.

            '
          type: number
          format: float
          minimum: 0
          maximum: 1
        data_reduction:
          description: Reduction of data.
          type: number
          format: float
          readOnly: true
        destroyed:
          description: 'Unique physical space (excluding snapshots) occupied by destroyed data within

            the child containers, in bytes.

            For buckets and filesystems, the destroyed space will be 0 as they cannot have

            child containers.

            For the whole array, the space will be the sum of all destroyed buckets and filesystems.

            '
          type: integer
          format: int64
          readOnly: true
        destroyed_virtual:
          description: 'The amount of destroyed logically written data within the child containers, in bytes.

            For buckets and filesystems, the destroyed virtual space will be 0 as they cannot have

            child containers.

            For the whole array, the space will be the sum of all destroyed buckets and filesystems.

            '
          type: integer
          format: int64
          readOnly: true
        shared:
          description: 'The space contributed by data that is not unique to a managed directory,

            or snapshot, measured in bytes.

            '
          type: integer
          format: int64
          readOnly: true
        snapshots:
          description: Physical usage by snapshots, other than unique in bytes.
          type: integer
          format: int64
          readOnly: true
        total_physical:
          description: 'Deprecated. See total_used for the newer functionality.

            The total physical space consumed by the file system, measured in bytes.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        total_provisioned:
          description: 'The effective provisioned size of the container, at which a hard limit

            will be applied.

            For a bucket with a `quota_limit` value and `hard_limit_enabled` set to `true`,

            this is its `quota_limit` value, unless the available space of the associated

            object store account, as defined by its `quota_limit` value, would prevent the

            bucket from reaching its own `quota_limit` value. In such a case,

            `total_provisioned` will reflect the smaller value.

            For a file system with a `provisioned` value and `hard_limit_enabled` set to

            `true`, this is the `provisioned` value of the file system.

            For an object store account with a `quota_limit` value and `hard_limit_enabled`

            set to `true`, this is the `quota_limit` value of the object store account.

            For the array, this is the sum of the file systems and accounts.

            Measured in bytes.

            '
          type: integer
          format: int64
          minimum: 0
          example: 19937690345472
        total_used:
          description: 'The total space consumed by customer data, measured in bytes.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        unique:
          description: 'Unique physical space occupied by customer data, in bytes.

            Excludes snapshots, destroyed.

            '
          type: integer
          format: int64
          readOnly: true
        virtual:
          description: 'The amount of logically written data, in bytes.

            Excludes destroyed data.

            '
          type: integer
          format: int64
          readOnly: true
          example: 19937690345472
    _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
    RealmDefaultsResponse:
      type: object
      properties:
        items:
          description: A list of realm default configurations.
          type: array
          items:
            $ref: '#/components/schemas/RealmDefaults'
    RealmSpaceGetResponse_2:
      allOf:
      - $ref: '#/components/schemas/PageInfo_2'
      - type: object
        properties:
          items:
            description: A list of realm space metrics objects.
            type: array
            items:
              $ref: '#/components/schemas/RealmSpace'
          total:
            description: 'Total of all records after filtering.

              If `total_only` query param is `true`, then no items will be returned.

              '
            type: array
            items:
              $ref: '#/components/schemas/RealmSpace'
    TagGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/TagResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    RealmPatch_2:
      allOf:
      - $ref: '#/components/schemas/_resource'
      - type: object
        properties:
          default_inbound_tls_policy:
            description: 'The default TLS policy governing inbound traffic from clients accessing the accessing the realm''s

              network interfaces. This TLS policy will be applied for any IP addresses within the realm that do not

              have a specific policy applied to them at a more granular level. If no `default_inbound_tls_policy`

              is configured, then IP addresses within the realm that do not have a specific policy

              applied to them at a more granular level will not be accessible using TLS.

              '
            title: ReferenceWritable
            allOf:
            - $ref: '#/components/schemas/_referenceWritable'
          destroyed:
            description: 'Returns a value of `true` if the realm has been destroyed and is pending eradication.

              The realm cannot be modi

# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/openapi/pure-storage-realms-api-openapi.yml

Pure Storage Realms API

Operations 18

Documentation

Specifications

Code Examples

Schemas & Data

Other Resources