Pure Storage Realms API

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

Documentation

Specifications

Code Examples

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-array-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-volume-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flasharray-rest-api-host-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-array-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flasharray-rest-api-volume-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-file-system-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-bucket-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/flashblade-rest-api-array-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-file-system-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/flashblade-rest-api-bucket-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-array-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-metric-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-schema/pure1-cloud-api-alert-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-structure/pure1-cloud-api-array-structure.json

Other Resources

🔗
SDKs
https://pypi.org/project/py-pure-client/
🔗
SDKs
https://github.com/PureStorage-OpenConnect/PureStorage.Pure1
🔗
SDKs
https://github.com/PureStorage-OpenConnect/powershell-toolkit-3
🔗
SDKs
https://github.com/PureStorage-OpenConnect/rest-client
🔗
Integrations
https://github.com/PureStorage-OpenConnect/terraform-provider-flash
🔗
Integrations
https://github.com/PureStorage-OpenConnect/pure-fa-openmetrics-exporter
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flasharray-rest-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-volume-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flasharray-rest-api-array-example.json
🔗
SDKs
https://github.com/PureStorage-OpenConnect/flashblade-powershell
🔗
SDKs
https://github.com/purestorage/purity_fb_python_client
🔗
Integrations
https://github.com/PureStorage-OpenConnect/pure-fb-openmetrics-exporter
🔗
Tools
https://github.com/PureStorage-OpenConnect/flashblade-mcp-server
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-flashblade-rest-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-file-system-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/flashblade-rest-api-bucket-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/json-ld/pure-storage-pure1-cloud-api-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/pure-storage/refs/heads/main/examples/pure1-cloud-api-array-example.json

OpenAPI Specification

pure-storage-realms-api-openapi.yml Raw ↑
openapi: 3.0.1
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:
    RealmDefaults:
      allOf:
      - $ref: '#/components/schemas/_context_2'
      - type: object
        properties:
          object_store:
            type: array
            description: Default configurations for object store.
            items:
              title: ObjectStoreDefault
              allOf:
              - $ref: '#/components/schemas/_objectStoreDefault'
          realm:
            description: Realm for the defaults.
            readOnly: true
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference_2'
    ContainerPerformanceGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/_errorContextResponse'
      - type: object
        properties:
          items:
            description: 'Performance data.

              If `total_only=true`, the `items` list will be empty.

              '
            type: array
            items:
              $ref: '#/components/schemas/ContainerPerformance'
          total:
            description: 'The aggregate value of all items after filtering.

              When applicable, the average value is displayed instead.

              If applicable, the values are displayed for each field.

              '
            type: array
            items:
              $ref: '#/components/schemas/ContainerPerformance'
    _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
    _objectStoreDefault:
      type: object
      description: Configuration of defaults for object store.
      properties:
        server:
          description: 'Default server for new entities created in object store.

            '
          title: ReferenceWritable
          allOf:
          - $ref: '#/components/schemas/_referenceWritable'
    RealmGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/RealmResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
      - type: object
        properties:
          total:
            description: 'The aggregate value of all items after filtering. When applicable, the average value is

              displayed instead. The values are displayed for each field, if meaningful.

              '
            type: array
            items:
              $ref: '#/components/schemas/Realm'
    _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
    Tag:
      allOf:
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          copyable:
            description: 'Specifies whether or not to include the tag when copying the parent resource.

              If set to `true`, the tag is included in resource copying.

              If set to `false`, the tag is not included.

              If not specified, defaults to `true`.

              '
            type: boolean
            example: true
          key:
            description: 'Key of the tag. Supports up to 64 Unicode characters.

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

              Namespace identifies the category of the tag. Omitting the namespace

              defaults to the namespace `default`. The `pure*` namespaces are

              reserved for plugins and integration partners. It is recommended

              that customers avoid using reserved namespaces.

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

              '
            type: string
            example: staging
    _performance_others:
      type: object
      properties:
        mirrored_others_per_sec:
          description: The number of mirrored other requests processed per second.
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        others_per_sec:
          description: The number of other requests processed per second.
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        usec_per_mirrored_other_op:
          description: 'The average time it takes the array to process a mirrored I/O other request, measured in

            microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        usec_per_other_op:
          description: 'The average time it takes the array to process an I/O other request, measured in

            microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
      x-readOnly: true
    Realm:
      allOf:
      - $ref: '#/components/schemas/_resource'
      - $ref: '#/components/schemas/_context'
      - description: 'A realm is an administrative domain, a data container,

          and a namespace for pods, hosts, and host groups.

          '
        type: object
        properties:
          created:
            description: 'Creation timestamp of the realm.

              '
            type: integer
            format: int64
            readOnly: true
          destroyed:
            description: 'Returns a value of `true` if the realm has been destroyed and is pending eradication.

              The realm cannot be modified while it is in the destroyed state.

              The `time_remaining` value displays the amount of time left until the destroyed

              realm is permanently eradicated. Once eradication has begun, the realm can no

              longer be recovered. Before the `time_remaining` period has elapsed,

              the destroyed realm can be recovered through the PATCH method

              '
            type: boolean
          eradication_config:
            title: ContainerEradicationConfig
            allOf:
            - $ref: '#/components/schemas/ContainerEradicationConfig'
          qos:
            description: 'Displays QoS limit information.

              '
            title: ContainerQos
            allOf:
            - $ref: '#/components/schemas/_containerQos'
          quota_limit:
            description: 'The logical quota limit of the realm, measured in bytes.

              '
            type: integer
            format: int64
            maximum: 4503599627370496
            readOnly: true
          space:
            description: 'Displays provisioned size and physical storage consumption

              information for the realm.

              '
            title: SpaceNoDeprecatedPhysicalOrEffective
            allOf:
            - $ref: '#/components/schemas/_spaceNoDeprecatedPhysicalOrEffective'
          time_remaining:
            description: 'Time in milliseconds before the realm is eradicated.

              `null` if not destroyed.

              '
            type: integer
            format: int64
            readOnly: true
    RealmGetResponse_2:
      allOf:
      - $ref: '#/components/schemas/_context_2'
      - $ref: '#/components/schemas/PageInfo_2'
      - $ref: '#/components/schemas/RealmResponse'
      - $ref: '#/components/schemas/_errorContextResponse_2'
      - properties:
          total:
            $ref: '#/components/schemas/Realm_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
    NonCopyableTag:
      type: object
      properties:
        key:
          description: 'Key of the tag. Supports up to 64 Unicode characters.

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

            Namespace identifies the category of the tag. Omitting the namespace

            defaults to the namespace `default`. The `pure*` namespaces are

            reserved for plugins and integration partners. It is recommended

            that customers avoid using reserved namespaces.

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

            '
          type: string
          example: staging
    RealmSpaceGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - type: object
        properties:
          items:
            description: 'Displays a list of all items after filtering.

              If applicable, the values are displayed for each name.

              If `total_only=true`, the `items` list will be empty.

              '
            type: array
            items:
              $ref: '#/components/schemas/ResourceRealmSpace'
          total:
            description: 'The aggregate value of all items after filtering.

              When applicable, the average value is displayed instead.

              The values are displayed for each field, if meaningful.

              '
            type: array
            items:
              $ref: '#/components/schemas/ResourceRealmSpace'
    Realm_2:
      allOf:
      - $ref: '#/components/schemas/_resource'
      - type: object
        properties:
          created:
            description: Creation timestamp of the realm.
            type: integer
            format: int64
            readOnly: true
          default_inbound_tls_policy:
            description: 'The default TLS policy governing inbound traffic from clients accessing the accessing the realm''s

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

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

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

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

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

              The realm cannot be modified while it is in the destroyed state.

              The `time_remaining` value displays the amount of time left until the destroyed

              realm is permanently eradicated. Once eradication has begun, the realm

# --- 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