Pure Storage Host Groups API

Host groups implement consistent connections between a set of hosts and one or more volumes. Connections are consistent in the sense that all hosts associated with a host group address a volume connected to the group by the same LUN. Host groups are typically used to provide a common view of storage volumes to the hosts in a clustered application.

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-host-groups-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Host Groups 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: Host Groups
  description: 'Host groups implement consistent connections between a set of hosts and one or more volumes.

    Connections are consistent in the sense that all hosts associated with a host group

    address a volume connected to the group by the same LUN. Host groups are typically

    used to provide a common view of storage volumes to the hosts in a clustered application.

    '
paths:
  /api/2.52/host-groups:
    get:
      tags:
      - Host Groups
      summary: Pure Storage List Host Groups
      description: 'Displays a list of host groups.


        '
      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/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostGroupGetResponse'
        '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/HostGroupGetResponse'
    post:
      tags:
      - Host Groups
      summary: Pure Storage Create a Host Group and Upsert Tags
      description: 'Creates a host group in which the `names` query parameter is required.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostGroupPost'
        required: false
        x-codegen-request-body-name: host-group
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostGroupResponse'
      x-codegen-request-body-name: host-group
    delete:
      tags:
      - Host Groups
      summary: Pure Storage Delete a Host Group
      description: 'Deletes a host group in which the `names` query parameter is required.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - Host Groups
      summary: Pure Storage Modify a Host Group
      description: 'Modifies a host group in which the `names` query parameter is required.


        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/From_member_ids'
      - $ref: '#/components/parameters/From_member_names'
      - $ref: '#/components/parameters/Modify_resource_access_on_move'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/To_member_ids'
      - $ref: '#/components/parameters/To_member_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HostGroupPatch'
        required: true
        x-codegen-request-body-name: host-group
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HostGroupResponse'
      x-codegen-request-body-name: host-group
  /api/2.52/host-groups/hosts:
    get:
      tags:
      - Host Groups
      summary: Pure Storage List Host Groups That Are Associated with Hosts
      description: 'Displays a list of host groups that are associated with hosts.


        '
      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/Group_names'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Member_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberNoIdAllGetResponse'
        '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/MemberNoIdAllGetResponse'
    post:
      tags:
      - Host Groups
      summary: Pure Storage Create a Membership to a Host Group
      description: 'Create a membership between a host and a host group. Adding a membership to a host group

        automatically connects the host to all volumes associated with the group. Multiple hosts can be

        belong to a host group, but a host can only belong to one host group. Hosts can be added to host

        groups at any time. The `group_names` and `member_names` parameters are required and must be set

        together, and only one host group can be specified at a time.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Group_names'
      - $ref: '#/components/parameters/Member_names'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberNoIdAllResponse'
    delete:
      tags:
      - Host Groups
      summary: Pure Storage Delete a Membership from a Host Group
      description: 'Deletes a membership from a host group. Removing a membership from a host group automatically

        disconnects the host from all volumes associated with the group.

        Hosts can be removed from host groups at any time.

        The `group_names` and `member_names` parameters are required

        and must be set together, and only one host group can be specified at a time.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Group_names'
      - $ref: '#/components/parameters/Member_names'
      responses:
        '200':
          description: OK
          content: {}
  /api/2.52/host-groups/performance:
    get:
      tags:
      - Host Groups
      summary: Pure Storage List Host Group Performance Data
      description: 'Displays real-time and historical performance data, real-time latency data, and average I/O

        sizes of all host groups, displayed both by host group and by total size across all host

        groups. This data represents volumes that are connected to the host groups on the local

        array and stretched volumes connected to the host groups on arrays that are connected by

        synchronous replication.


        '
      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/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/ResourcePerformanceNoIdGetResponse'
        '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/ResourcePerformanceNoIdGetResponse'
  /api/2.52/host-groups/performance/by-array:
    get:
      tags:
      - Host Groups
      summary: Pure Storage List Host Group Performance Data by Array
      description: 'Displays real-time and historical performance data, real-time latency data, and average I/O size

        data. The data is displayed by total size across all host groups on each array and by individual

        host group on each array. The displayed data represents the volumes that are connected to a host

        group on the current array and the volumes that are connected to a host group on any remote

        arrays that are visible to the current array.


        '
      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/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/ResourcePerformanceNoIdByArrayGetResponse'
        '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/ResourcePerformanceNoIdByArrayGetResponse'
  /api/2.52/host-groups/protection-groups:
    get:
      tags:
      - Host Groups
      summary: Pure Storage List Host Groups That Are Members of Protection Groups
      description: 'Displays a list of host group members that belong to one or more protection groups.

        '
      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/Group_ids'
      - $ref: '#/components/parameters/Group_names'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Member_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberNoIdMemberGetResponse'
        '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/MemberNoIdMemberGetResponse'
    post:
      tags:
      - Host Groups
      summary: Pure Storage Create a Host Group
      description: 'Creates a host group member and assigns to a protection group.

        Members that are already in the protection group are not affected.

        For asynchronous replication, only members of the same type can belong to a protection group.

        The `group_names` parameter represents the name of the protection group, and

        the `member_names` parameter represents the name of the host group.

        The `group_names` and `member_names` parameters are required and must be set together.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Group_ids'
      - $ref: '#/components/parameters/Group_names'
      - $ref: '#/components/parameters/Member_names'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberNoIdMemberResponse'
    delete:
      tags:
      - Host Groups
      summary: Pure Storage Delete a Host Group from a Protection Group
      description: 'Deletes a host group member from a protection group.

        After the member has been removed, it is no longer protected by the group.

        Any protection group snapshots that were taken before the member was removed are not affected.

        Removing a member from a protection group does not delete the member from the array or realm,

        and the member can be added back to the protection group at any time.

        The `group_names` parameter represents the name of the protection group, and

        the `member_names` parameter represents the name of the host group.

        The `group_names` and `member_names` parameters are required and must be set together.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Group_ids'
      - $ref: '#/components/parameters/Group_names'
      - $ref: '#/components/parameters/Member_names'
      responses:
        '200':
          description: OK
          content: {}
  /api/2.52/host-groups/qos:
    get:
      tags:
      - Host Groups
      summary: Pure Storage List Host Group QoS Config
      description: 'Displays real-time and historical QoS config data for each host group.

        '
      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/HostGroupQosGetResponse'
        '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/HostGroupQosGetResponse'
  /api/2.52/host-groups/space:
    get:
      tags:
      - Host Groups
      summary: Pure Storage List Host Group Space Information
      description: 'Displays provisioned size and physical storage consumption data for each host group.

        '
      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/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceSpaceNoIdGetResponse'
        '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/ResourceSpaceNoIdGetResponse'
  /api/2.52/host-groups/tags:
    get:
      tags:
      - Host Groups
      summary: Pure Storage List Tags
      description: 'Displays the list of tags on host group objects.

        '
      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:
      - Host Groups
      summary: Pure Storage Delete Tags
      description: 'Deletes specified tags on host group objects.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Keys'
      - $ref: '#/components/parameters/Namespaces'
      - $ref: '#/components/parameters/Resource_ids'
      - $ref: '#/components/parameters/Resource_names'
      responses:
        '200':
          description: OK
          content: {}
  /api/2.52/host-groups/tags/batch:
    put:
      tags:
      - Host Groups
      summary: Pure Storage Update Tags
      description: 'Updates tags.

        '
      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 one already exists, updated.
        content:
          application/json:
            schema:
              maxItems: 30
              minItems: 1
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/NonCopyableTagBatch'
        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
components:
  schemas:
    HostGroupQosGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/_errorContextResponse'
      - type: object
        properties:
          items:
            description: 'Specifies the Quality of Service (QoS) configuration data.

              '
            type: array
            items:
              $ref: '#/components/schemas/QosMetricsCeilings'
    ResourcePerformanceNoIdByArray:
      allOf:
      - $ref: '#/components/schemas/ResourcePerformanceNoId'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          array:
            description: 'The array on which the performance metrics were recorded.

              '
            title: Resource
            allOf:
            - $ref: '#/components/schemas/_resource'
    TagGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/TagResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    _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'
    HostGroup:
      allOf:
      - $ref: '#/components/schemas/_resourceNoId'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          connection_count:
            description: The number of volumes connected to the host group.
            type: integer
            format: int64
            readOnly: true
            example: 3
          destroyed:
            description: 'Returns a value of `true` if the host group has been destroyed

              with its container realm and is pending eradication.

              The `time_remaining` value displays the amount of time left

              until the destroyed host group is permanently eradicated.

              Before the `time_remaining` period has elapsed, the destroyed host group

              will be recovered if its container realm is recovered.

              Once the `time_remaining` period has elapsed,

              the host group is permanently eradicated and can no longer be recovered.

              '
            type: boolean
            readOnly: true
          host_count:
            description: The number of hosts in the host group.
            type: integer
            format: int64
            readOnly: true
            example: 3
          is_local:
            description: Returns a value of `true` if the host or host group belongs to the current array. Returns a value of `false` if the host or host group belongs to a remote array.
            type: boolean
            readOnly: true
          qos:
            description: 'Displays QoS limit information.

              '
            title: ContainerQosCeilings
            allOf:
            - $ref: '#/components/schemas/_containerQosCeilings'
          space:
            description: 'Displays provisioned (virtual) size and physical storage consumption

              information for the sum of all volumes connected to the specified host.

              '
            title: Space
            allOf:
            - $ref: '#/components/schemas/_space'
          time_remaining:
            description: 'The amount of time left until the destroyed host group is permanently eradicated,

              measured in milliseconds.

              '
            type: integer
            format: int64
            readOnly: true
    ResourceSpaceNoIdGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/_errorContextResponse'
      - type: object
        properties:
          items:
            type: array
            items:
              $ref: '#/components/schemas/ResourceSpaceNoId'
    MemberNoIdMemberGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/MemberNoIdMemberResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    HostGroupPost:
      type: object
      properties:
        qos:
          description: Sets QoS limits.
          title: ContainerQosCeilings
          allOf:
          - $ref: '#/components/schemas/_containerQosCeilings'
        tags:
          description: 'The list of tags to be upserted with the object.

            '
          type: array
          items:
            $ref: '#/components/schemas/NonCopyableTag'
    _referenceNoId:
      type: object
      properties:
        name:
          description: 'The resource name, such as volume name, pod name, snapshot name, and so on.

            '
          type: string
    _newName:
      type: object
      properties:
        name:
          description: The new name for the resource.
          type: string
    _resource:
      description: 'An ordinary (as opposed to built-in) resource that can be created, named,

        renamed or deleted by the user. This might be a virtual resource (e.g., a

        file system), or correspond to something in the environment, like a host or a

        server.

        '
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified and cannot refer to another resource.

            '
          type: string
          readOnly: true
        name:
          description: 'A user-specified name.

            The name must be locally unique and can be changed.

            '
          type: string
    _reference:
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified.

            '
          type: string
        name:
          description: 'The resource name, such as volume name, pod name,

            snapshot name, and so on.

            '
          type: string
      x-aliases:
      - _referenceWithoutType
    ResourceSpaceNoId:
      allOf:
      - $ref: '#/components/schemas/_builtInResourceNoId'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          space:
            description: 'Displays size and space consumption information.

              '
            title: Space
            allOf:
            - $ref: '#/components/schemas/_space'
          time:
            type: integer
            format: int64
            readOnly: true
        x-readOnly: true
    _containerQosCeilings:
      type: object
      properties:
        bandwidth_limit:
          description: 'The maximum QoS bandwidth limit for the container.

            Whenever throughput exceeds the bandwidth limit, throttling occurs.

            Measured in bytes per second. Maximum limit is 512 GB/s.

            '
          title: Qos_bw_limit_type
          allOf:
          - $ref: '#/components/schemas/_qos_bw_limit_type'
        iops_limit:
          description: 'The QoS IOPs limit for the container.

            '
          title: Qos_iops_limit_type
          allOf:
          - $ref: '#/components/schemas/_qos_iops_limit_type'
    _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
    TagResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    MemberNoIdAllResponse:
      type: object
      properties:
        items:
          description: 'Displays a list of all items after filtering.

            The values are displayed for each name where meaningful.

            '
          type: array
          items:
            $ref: '#/components/schemas/MemberNoIdAll'
    MemberNoIdAllGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/MemberNoIdAllResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    _resourceNoId:
      description: 'An ordinary (as opposed to built-in) resource that can be created, named,

        renamed or deleted by the user. This might be a virtual resource (e.g., a

        volume), or correspond to something in the environment, like a host or a

        server.

        '
      type: object
      properties:
        name:
          description: 'A user-specified name.

            The name must be locally unique and can be changed.

            '
          type: string
    ResourcePerformanceNoId:
      allOf:
      - $ref: '#/components/schemas/_performance'
      - $ref: '#/components/schemas/_performance_others'
      - $ref: '#/components/schemas/_resourceNoId'
      - $ref: '#/components/schemas/_context'
    _qos_bw_limit_type:
      type: integer
      format: int64
      minimum: 1048576
      maximum: 549755813888
    HostGroupPatch:
      allOf:
      - $ref: '#/components/schemas/_newName'
      - type: object
        properties:
          qos:
            description: Sets QoS limits.
            title: ContainerQosCeilings_patch
            allOf:
            - $ref: '#/components/schemas/_containerQosCeilings_patch'
    MemberNoIdMemberResponse:
      type: object
      properties:
        items:
          description: 'Displays a list of all items after filtering.

            The values are displayed for each name, if meaningful.

            '
          type: array
          items:
           

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