Pure Storage Pods API

Synchronous replication is managed through pods. A pod representing a collection of protection groups and volumes is created on one array and stretched to another array, resulting in fully synchronized writes between the two arrays. A pod can contain a mix of volumes, and protection groups with member volumes. Writes to the pod coming into either array are immediately synchronized and seen on both arrays.

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-pods-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Pods 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: Pods
  description: 'Synchronous replication is managed through pods. A pod representing a collection of protection

    groups and volumes is created on one array and stretched to another array, resulting in fully

    synchronized writes between the two arrays. A pod can contain a mix of volumes, and protection

    groups with member volumes. Writes to the pod coming into either array are immediately

    synchronized and seen on both arrays.

    '
paths:
  /api/2.52/pods:
    get:
      tags:
      - Pods
      summary: Pure Storage List Pods
      description: 'Displays a list of pods that are stretched to this 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/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/PodGetResponse'
        '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/PodGetResponse'
    post:
      tags:
      - Pods
      summary: Pure Storage Create a Pod
      description: 'Creates a pod on the local array.

        Each pod must be given a unique name across the arrays to which they are stretched.

        A pod cannot be stretched to an array that already contains a pod with the same name.

        After a pod has been created, add volumes and protection groups,

        and then stretch the pod to another connected array or realm.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_throttle_operation'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PodPost'
        required: true
        x-codegen-request-body-name: pod
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodResponse'
      x-codegen-request-body-name: pod
    delete:
      tags:
      - Pods
      summary: Pure Storage Delete a Pod
      description: 'Deletes a pod that has been destroyed and is pending eradication.

        Eradicated pods cannot be recovered. Pods are destroyed using 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:
      - Pods
      summary: Pure Storage Modify a Pod
      description: 'Modifies pod details.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Abort_quiesce'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Destroy_contents'
      - $ref: '#/components/parameters/From_member_ids'
      - $ref: '#/components/parameters/From_member_names'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Move_with_host_group_names'
      - $ref: '#/components/parameters/Move_with_host_names'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Promote_from'
      - $ref: '#/components/parameters/Quiesce'
      - $ref: '#/components/parameters/Skip_quiesce'
      - $ref: '#/components/parameters/To_member_ids'
      - $ref: '#/components/parameters/To_member_names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PodPatch'
        required: true
        x-codegen-request-body-name: pod
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodResponse'
      x-codegen-request-body-name: pod
  /api/2.52/pods/arrays:
    get:
      tags:
      - Pods
      summary: Pure Storage List Pods and Their the Array Members
      description: 'Displays a list of pods and the local and remote arrays over which the pods are stretched.

        Pods with realm members will not be returned.

        The optional `group_names` parameter represents the name of the pod.

        The optional `member_names` parameter

        represents the name of the array over which the pod is stretched.

        (Deprecated) Use pods/members instead.)

        '
      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'
    post:
      tags:
      - Pods
      summary: Pure Storage Creates a Pod to Be Stretched to an Array
      description: 'Creates a pod to be stretched to an array.

        When a pod is stretched to an array,

        the data in the arrays over which the pod is stretched is synchronously replicated.

        The `group_names` parameter represents the name of the pod to be stretched.

        The `member_names` parameter represents the name of the array over which the pod is

        to be stretched.

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

        (Deprecated) Use pods/members instead.

        '
      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_ids'
      - $ref: '#/components/parameters/Member_names'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MemberResponse'
    delete:
      tags:
      - Pods
      summary: Pure Storage Delete a Pod That Was Stretched to an Array
      description: 'Deletes a pod that was stretchd to an array, collapsing the pod to a single array.

        Unstretch a pod from an array when the volumes within the stretched pod

        no longer need to be synchronously replicated between the two arrays.

        After a pod has been unstretched, synchronous replication stops.

        A destroyed version of the pod with ''restretch'' appended to the pod name

        is created on the array that no longer has the pod.

        The restretched pod represents a point-in-time snapshot of the pod,

        just before it was unstretched.

        The restretch pod enters an eradication pending period

        starting from the time that the pod was unstretched.

        A restretched pod can be cloned or destroyed, but it cannot be explicitly recovered.

        The `group_names` parameter represents the name of the pod to be unstretched.

        The `member_names` parameter represents the name of the array from which the pod is

        to be unstretched.

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

        (Deprecated) Use pods/members instead.

        '
      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_ids'
      - $ref: '#/components/parameters/Member_names'
      - $ref: '#/components/parameters/With_unknown'
      responses:
        '200':
          description: OK
          content: {}
  /api/2.52/pods/members:
    get:
      tags:
      - Pods
      summary: Pure Storage List Pods and Their Members
      description: 'Displays a list of pods and the local and remote members over which the pods are stretched.

        Currently either array or realm is supported as member.

        '
      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/Member_ids'
      - $ref: '#/components/parameters/Member_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Pod_ids'
      - $ref: '#/components/parameters/Pod_names'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Total_item_count'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodMemberGetResponse'
        '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/PodMemberGetResponse'
    post:
      tags:
      - Pods
      summary: Pure Storage Creates a Pod to Be Stretched to a Member
      description: 'Creates a pod to be stretched to a member.

        When a pod is stretched to an array or a realm on another array, the data in the arrays

        or realms over which the pod is stretched is synchronously replicated.

        The `member_names` or `member_ids` parameter represents the array or realm over which

        the pod is to be stretched.

        Both pod and member must be specified by name or ID.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Member_ids'
      - $ref: '#/components/parameters/Member_names'
      - $ref: '#/components/parameters/Pod_ids'
      - $ref: '#/components/parameters/Pod_names'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodMemberResponse'
    delete:
      tags:
      - Pods
      summary: Pure Storage Delete a Member from a Pod
      description: 'Deletes a stretched pod from an array or realm, collapsing the pod to a member array

        or realm. Unstretch a pod from an array or realm when the volumes within the stretched

        podno longer need to be synchronously replicated between the two members.

        After a pod has been unstretched, synchronous replication stops.

        A destroyed version of the pod with ''restretch'' appended to the pod name

        is created on the member that no longer has the pod.

        The restretched pod represents a point-in-time snapshot of the pod,

        just before it was unstretched.

        The restretched pod enters an eradication pending period

        starting from the time that the pod was unstretched.

        A restretched pod can be cloned or destroyed, but it cannot be explicitly recovered.

        The `member_names` parameter represents the name of the array or realm from which the

        pod is to be unstretched.

        Both pod and member must be specified by name or ID.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Member_ids'
      - $ref: '#/components/parameters/Member_names'
      - $ref: '#/components/parameters/Pod_ids'
      - $ref: '#/components/parameters/Pod_names'
      - $ref: '#/components/parameters/With_unknown'
      responses:
        '200':
          description: OK
          content: {}
  /api/2.52/pods/performance:
    get:
      tags:
      - Pods
      summary: Pure Storage List Pod Performance Data
      description: 'Displays real-time and historical performance data, real-time latency data,

        and average I/O sizes across all pods, displayed both by pod and as a total across all pods.

        '
      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/Perf_protocol_type'
      - $ref: '#/components/parameters/Perf_protocol_group'
      - $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/pods/performance/by-array:
    get:
      tags:
      - Pods
      summary: Pure Storage List Pod 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 as a total across all pods on the local array and by individual pod.

        '
      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/Perf_protocol_type'
      - $ref: '#/components/parameters/Perf_protocol_group'
      - $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/PodPerformanceByArrayGetResponse'
        '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/PodPerformanceByArrayGetResponse'
  /api/2.52/pods/performance/replication:
    get:
      tags:
      - Pods
      summary: Pure Storage List Pod Replication Performance Data
      description: 'Displays pod replication performance data.

        The data returned is the real-time and historical performance data for each replication type

        at the pod level. Values include `continuous`, `periodic`, `resync`, and `sync`.


        '
      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/Historical_total_only'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodPerformanceReplicationGetResponse'
        '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/PodPerformanceReplicationGetResponse'
  /api/2.52/pods/performance/replication/by-array:
    get:
      tags:
      - Pods
      summary: Pure Storage List Pod Replication Performance Data by Array
      description: 'Displays pod replication performance data, organized by array.

        The data returned is the real-time and historical performance data for each replication type

        at the pod level. Values include `continuous`, `periodic`, `resync`, and `sync`.


        '
      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/PodPerformanceReplicationByArrayGetResponse'
        '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/PodPerformanceReplicationByArrayGetResponse'
  /api/2.52/pods/space:
    get:
      tags:
      - Pods
      summary: Pure Storage List Pod Space Information
      description: 'Displays provisioned size and physical storage consumption data for each pod on the

        local 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/ResourcePodSpaceGetResponse'
        '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/ResourcePodSpaceGetResponse'
  /api/2.52/pods/tags:
    get:
      tags:
      - Pods
      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:
      - Pods
      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/pods/tags/batch:
    put:
      tags:
      - Pods
      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 already existing, updated.
        content:
          application/json:
            schema:
              maxItems: 30
              minItems: 1
              uniqueItems: true
              type: array
              items:
                $ref: '#/components/schemas/Tag'
        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.52/pods/test:
    post:
      tags:
      - Pods
      summary: Pure Storage Create an Attempt to Clone a Pod
      description: 'Creates an attempt to clone a pod on the local array without actually cloning it

        to test whether the pod can be successfully cloned. This action does not suppport pod creation.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Allow_throttle_operation'
      - $ref: '#/components/parameters/Context_names'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PodPost'
        required: true
        x-codegen-request-body-name: pod
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestResultWithResourceWithIdPostResponse'
      x-codegen-request-body-name: pod
  /api/1.5/pods:
    get:
      tags:
      - Pods
      summary: Pure Storage Get Pods
      description: 'Retrieves information about pod objects.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization_2'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token_2'
      - $ref: '#/components/parameters/Filter_2'
      - $ref: '#/components/parameters/Ids_2'
      - $ref: '#/components/parameters/Limit_2'
      - $ref: '#/components/parameters/Names_2'
      - $ref: '#/components/parameters/Offset_2'
      - $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
            X-RateLimit-Remaining-second:
              description: 'The number of requests remaining for the organization in that second.

                '
              schema:
                type: integer
            X-RateLimit-Remaining-minute:
              description: 'The number of requests remaining for the organization in that minute.

                '
              schema:
                type: integer
            X-RateLimit-Limit-second:
              description: The number of requests available per second.
              schema:
                type: integer
            X-RateLimit-Limit-minute:
              description: The number of requests available per minute.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PodGetResponse_2'
        '400':
          $ref: '#/components/responses/Error400'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
components:
  schemas:
    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'
    ErrorNoContext:
      type: object
      properties:
        message:
          type: string
          example: Something was wrong
    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:

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