Pure Storage Volume Groups API

openapi: 3.2.0
info:
  title: FlashArray REST Active Directory Volume 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: Volume Groups
  description: 'Volume groups organize volumes into logical groupings. If virtual volumes are configured, each

    volume group on the FlashArray array represents its associated virtual machine, and inside each

    of those volumes groups are the FlashArray volumes that are assigned to the virtual machine.

    Volume groups that are associated with virtual machines have names that begin with `vvol-` and

    end with the virtual machine name.

    '
paths:
  /api/2.52/volume-groups:
    get:
      tags:
      - Volume Groups
      summary: Pure Storage List Volume Groups
      description: 'Displays a list of volume groups, including those pending eradication.

        '
      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/VolumeGroupGetResponse'
        '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/VolumeGroupGetResponse'
    post:
      tags:
      - Volume Groups
      summary: Pure Storage Create a Volume Group and Upsert Tags.
      description: 'Creates a volume group. The volume group itself does not contain any meaningful

        content; instead, it acts as a container that is used to organize volumes.

        Once a volume group has been created, volumes can be created inside the volume group or moved

        into and out of the volume group.

        '
      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/VolumeGroupPost'
        required: true
        x-codegen-request-body-name: volume-group
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeGroupResponse'
      x-codegen-request-body-name: volume-group
    delete:
      tags:
      - Volume Groups
      summary: Pure Storage Delete a Volume Group
      description: 'Deletes a volume group that has been destroyed and is pending eradication.

        Eradicated volume groups cannot be recovered.

        Volume groups are destroyed through the PATCH method.

        The `ids` or `names` parameter is required, but they cannot be set together.

        '
      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:
      - Volume Groups
      summary: Pure Storage Modify a Volume Group
      description: 'Modifies a volume group. You can rename, destroy, recover, or set QoS limits for a volume group.

        To rename a volume group, set `name` to the new name.

        To destroy a volume group, set `destroyed=true`.

        To recover a volume group that has been destroyed and is pending eradication, set

        `destroyed=false`.

        Sets the bandwidth and IOPS limits of a volume group through the respective `bandwidth_limit`

        and `iops_limit` parameter. The `ids` or `names` parameter is required, but they cannot be set

        together.

        Sets the priority adjustment for a volume group using the `priority_adjustment_operator` and

        `priority_adjustment_value` fields.

        '
      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/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VolumeGroupPatch'
        required: true
        x-codegen-request-body-name: volume-group
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VolumeGroupResponse'
      x-codegen-request-body-name: volume-group
  /api/2.52/volume-groups/performance:
    get:
      tags:
      - Volume Groups
      summary: Pure Storage List Volume Group Performance Data
      description: 'Displays real-time and historical performance data, real-time latency data, and average I/O

        sizes for each volume group and and as a total of all volume groups across the entire 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/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/ResourcePerformanceGetResponse'
        '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/ResourcePerformanceGetResponse'
  /api/2.52/volume-groups/qos:
    get:
      tags:
      - Volume Groups
      summary: Pure Storage List Volume Group QoS Config
      description: 'Displays real-time and historical QoS configuration data for each volume 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/VolumeGroupQosGetResponse'
        '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/VolumeGroupQosGetResponse'
  /api/2.52/volume-groups/space:
    get:
      tags:
      - Volume Groups
      summary: Pure Storage List Volume Group Space Information
      description: 'Displays the provisioned size and physical storage consumption data

        for each volume 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'
      - $ref: '#/components/parameters/Total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceSpaceGetResponse'
        '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/ResourceSpaceGetResponse'
  /api/2.52/volume-groups/volumes:
    get:
      tags:
      - Volume Groups
      summary: Pure Storage List Volume Groups with Volumes
      description: Displays a list of volume groups that contain volumes.
      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_ids'
      - $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/MemberGetResponse'
        '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/MemberGetResponse'
  /api/2.52/volume-groups/tags:
    get:
      tags:
      - Volume Groups
      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:
      - Volume Groups
      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/volume-groups/tags/batch:
    put:
      tags:
      - Volume Groups
      summary: Pure Storage Update Tags
      description: Updates 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 one already exists, updated.
        content:
          application/json:
            schema:
              maxItems: 30
              minItems: 1
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/TagBatch'
        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:
    MemberGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/MemberResponse'
      - $ref: '#/components/schemas/_errorContextResponse'
    _qos:
      type: object
      properties:
        bandwidth_limit:
          description: 'The maximum QoS bandwidth limit for the volume.

            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 volume.

            '
          title: Qos_iops_limit_type
          allOf:
          - $ref: '#/components/schemas/_qos_iops_limit_type'
    _qos_iops_limit_type:
      type: integer
      format: int64
      minimum: 100
      maximum: 100000000
    _performance:
      type: object
      properties:
        bytes_per_mirrored_write:
          description: 'The average I/O size per mirrored write, measured in bytes.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        bytes_per_op:
          description: 'The average I/O size for both read and write (all) operations.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        bytes_per_read:
          description: 'The average I/O size per read, measured in bytes.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        bytes_per_write:
          description: 'The average I/O size per write, measured in bytes.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        cached_read_bytes_per_sec:
          description: The number of cached bytes read, measured in bytes per second.
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        cached_reads_per_sec:
          description: The number of cached read requests, measured in requests per second.
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        mirrored_write_bytes_per_sec:
          description: 'The number of mirrored bytes written per second.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        mirrored_writes_per_sec:
          description: 'The number of mirrored writes per second.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        non_cached_read_bytes_per_sec:
          description: The number of non-cached bytes read, measured in bytes per second.
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        non_cached_reads_per_sec:
          description: The number of non-cached read requests, measured in requests per second.
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        qos_rate_limit_usec_per_mirrored_write_op:
          description: 'The average time it takes the array to process a mirrored I/O write request,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        qos_rate_limit_usec_per_read_op:
          description: 'The average time spent waiting due to QoS rate limiting for a read request,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        qos_rate_limit_usec_per_write_op:
          description: 'The average time that a write I/O request spends waiting

            as a result of the volume reaching its QoS bandwidth limit,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        qos_scheduling_usec_per_mirrored_write_op:
          description: 'The average time that a mirrored write I/O gets delayed due to QoS scheduling,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        qos_scheduling_usec_per_read_op:
          description: 'The average time that a read I/O gets delayed due to QoS scheduling,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        qos_scheduling_usec_per_write_op:
          description: 'The average time that a write I/O gets delayed due to QoS scheduling,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        queue_usec_per_mirrored_write_op:
          description: 'The average time that a mirrored write I/O request spends in the kernel waiting to be served,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        queue_usec_per_read_op:
          description: 'The average time that a read I/O request spends in the kernel waiting to be served,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        queue_usec_per_write_op:
          description: 'The average time that a write I/O request spends in the kernel waiting to be served,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        read_bytes_per_sec:
          description: 'The number of bytes read per second.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        read_cache_hit_ratio:
          description: The ratio of read requests served directly from the cache.
          type: number
          format: float
          minimum: 0
          maximum: 1
          readOnly: true
        reads_per_sec:
          description: 'The number of read requests processed per second.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        san_usec_per_mirrored_write_op:
          description: 'The average time required to transfer data

            from the initiator to the array for a mirrored write request,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        san_usec_per_read_op:
          description: 'The average time required to transfer data from the array

            to the initiator for a read request, measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        san_usec_per_write_op:
          description: 'The average time required to transfer data

            from the initiator to the array for a write request,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        service_usec_per_mirrored_write_op:
          description: 'The average time required for the array to service a mirrored write request,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        service_usec_per_read_op:
          description: 'The average time required for the array to service a read request,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        service_usec_per_read_op_cache_reduction:
          description: 'The percentage reduction in `service_usec_per_read_op` due to data cache

            hits. For example, a value of 0.25 indicates that the value of

            `service_usec_per_read_op` is 25% lower than it would have been without

            any data cache hits.

            '
          type: number
          format: float
          minimum: 0
          maximum: 1
        service_usec_per_read_op_cached:
          description: 'The average time required for the array to service a read request that is satisfied by a cache

            hit, measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        service_usec_per_read_op_non_cached:
          description: 'The average time required for the array to service a read request that is not satisfied by a

            cache hit, measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        service_usec_per_write_op:
          description: 'The average time required for the array to service a write request,

            measured in microseconds.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        time:
          description: 'The time when the sample performance data was taken,

            measured in milliseconds since the UNIX epoch.

            '
          type: integer
          format: int64
          readOnly: true
        usec_per_mirrored_write_op:
          description: 'The average time it takes the array to process a mirrored I/O write request,

            measured in microseconds.

            Beginning in Purity 6.3.14 and 6.4.10 and later,

            including later major versions (6.5.x, 6.6.x and beyond),

            queue time is included.

            The average time does not include SAN time or QoS rate limit time.

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

            measured in microseconds.

            Beginning in Purity 6.3.14 and 6.4.10 and later,

            including later major versions (6.5.x, 6.6.x and beyond),

            queue time is included.

            The average time does not include SAN time or QoS rate limit time.

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

            measured in microseconds.

            Beginning in Purity 6.3.14 and 6.4.10 and later,

            including later major versions (6.5.x, 6.6.x and beyond),

            queue time is included.

            The average time does not include SAN time or QoS rate limit time.

            '
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        write_bytes_per_sec:
          description: The number of bytes written per second.
          type: integer
          format: int64
          minimum: 0
          readOnly: true
        writes_per_sec:
          description: The number of write requests processed per second.
          type: integer
          format: int64
          minimum: 0
          readOnly: true
      x-readOnly: true
    _limit_unset_value:
      type: string
      minLength: 0
      maxLength: 0
    TagResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
    ResourceSpace:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          space:
            description: 'Displays size and space consumption information.

              '
            title: Space
            allOf:
            - $ref: '#/components/schemas/_space'
          time:
            description: 'The timestamp of when the data was taken, measured in milliseconds since the UNIX epoch.

              '
            type: integer
            format: int64
            readOnly: true
        x-readOnly: true
    Member:
      allOf:
      - $ref: '#/components/schemas/_context'
      - type: object
        properties:
          group:
            $ref: '#/components/schemas/_reference'
          member:
            $ref: '#/components/schemas/_reference'
    VolumeGroupPost:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - $ref: '#/components/schemas/_resource'
      - description: 'Volume groups organize FlashArray volumes into logical groupings.

          '
        type: object
        properties:
          destroyed:
            description: 'If set to `true`, destroys a volume group.

              If set to `false`, recovers a destroyed volume group. If not specified, defaults to `false`.

              '
            type: boolean
            readOnly: true
          priority_adjustment:
            $ref: '#/components/schemas/_priorityAdjustment'
          qos:
            $ref: '#/components/schemas/_qos'
          space:
            title: Space
            allOf:
            - $ref: '#/components/schemas/_space'
          tags:
            description: 'The list of tags to be upserted with the object.

              '
            type: array
            items:
              $ref: '#/components/schemas/Tag'
          time_remaining:
            description: 'The amount of time left until the destroyed volume group is permanently eradicated,

              measured in milliseconds.

              '
            type: integer
            format: int64
            readOnly: true
          volume_count:
            description: 'The number of volumes in the volume group.

              '
            type: integer
            format: int64
            readOnly: true
            example: 3
    _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'
    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
    ResourceSpaceGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/_errorContextResponse'
      - type: object
        properties:
          items:
            description: 'Displays a list of all items after filtering.

              If applicable, the values are displayed for each name.

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

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

              Where it makes more sense, the average value is displayed instead.

              If applicable, the values are displayed for each field.

             

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