Pure Storage Node Groups API

openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Node 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: Node Groups
  description: Node Groups can contain one or more nodes for file system creation management.
paths:
  /api/2.26/node-groups:
    get:
      tags:
      - Node Groups
      summary: Pure Storage GET Node-groups
      description: Display all array node groups.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeGroupGetResponse'
    post:
      tags:
      - Node Groups
      summary: Pure Storage POST Node-groups
      description: Create one or more node groups on the array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeGroupResponse'
    patch:
      tags:
      - Node Groups
      summary: Pure Storage PATCH Node-groups
      description: Update one or more node groups on the array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NodeGroupPatch'
        required: true
        x-codegen-request-body-name: node-group
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeGroupResponse'
    delete:
      tags:
      - Node Groups
      summary: Pure Storage DELETE Node-groups
      description: Delete one or more node groups from the array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
  /api/2.26/node-groups/nodes:
    get:
      tags:
      - Node Groups
      summary: Pure Storage GET Node-groups/nodes
      description: List membership associations between node groups and nodes on the array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Node_group_ids'
      - $ref: '#/components/parameters/Node_group_names'
      - $ref: '#/components/parameters/Node_ids'
      - $ref: '#/components/parameters/Node_names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeGroupNodeGetResponse'
    post:
      tags:
      - Node Groups
      summary: Pure Storage POST Node-groups/nodes
      description: Add one or more nodes to one or more node groups on the array.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Node_group_ids'
      - $ref: '#/components/parameters/Node_group_names'
      - $ref: '#/components/parameters/Node_ids'
      - $ref: '#/components/parameters/Node_names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeGroupNodeResponse'
    delete:
      tags:
      - Node Groups
      summary: Pure Storage DELETE Node-groups/nodes
      description: Remove one or more nodes from one or more groups.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Node_group_ids'
      - $ref: '#/components/parameters/Node_group_names'
      - $ref: '#/components/parameters/Node_ids'
      - $ref: '#/components/parameters/Node_names'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content: {}
  /api/2.26/node-groups/uses:
    get:
      tags:
      - Node Groups
      summary: Pure Storage GET Node-groups/uses
      description: List how node groups are being used and by what.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Names'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      responses:
        '200':
          description: OK
          headers:
            X-Request-ID:
              description: Supplied by client during request or generated by server.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeGroupUseGetResponse'
components:
  parameters:
    Node_group_names:
      name: node_group_names
      in: query
      description: 'A comma-separated list of node group names.

        If there is not at least one resource that matches each of the

        elements of `node_group_names`, then an error is returned.

        This cannot be provided in conjunction with the `node_group_ids` parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Offset:
      name: offset
      in: query
      description: 'The offset of the first resource to return from a collection.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Filter:
      name: filter
      in: query
      description: 'Narrows down the results to only the response objects

        that satisfy the filter criteria.

        '
      schema:
        type: string
    Continuation_token:
      name: continuation_token
      in: query
      description: 'A token used to retrieve the next page of data

        with some consistency guaranteed.

        The token is a Base64 encoded value.

        Set `continuation_token` to the system-generated token taken from the `x-next-token`

        header field of the response.

        A query has reached its last page when the response does not include a token.

        Pagination requires the `limit` and `continuation_token`

        query parameters.

        '
      schema:
        type: string
    XRequestId:
      name: X-Request-ID
      in: header
      description: 'Supplied by client during request or generated by server.

        '
      schema:
        type: string
    Node_ids:
      name: node_ids
      in: query
      description: 'A comma-separated list of node ids.

        If there is not at least one resource that matches each of the

        elements of `node_ids`, then an error is returned.

        This cannot be provided in conjunction with the `node_names`

        parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Limit:
      name: limit
      in: query
      description: 'Limits the size of the response to the specified number of objects on each page.

        To return the total number of resources, set `limit=0`.

        The total number of resources is returned as a `total_item_count` value.

        If the page size requested is larger than the system maximum limit,

        the server returns the maximum limit, disregarding the requested page size.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    Names:
      name: names
      in: query
      description: 'Performs the operation on the unique names specified.

        Enter multiple names in comma-separated format.

        For example, `name01,name02`.


        If there is not at least one resource that matches

        each of the elements of `names`, then an error is returned,

        except when creating new resources.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Ids:
      name: ids
      in: query
      description: 'A comma-separated list of resource IDs.

        If after filtering, there is not at least one resource that matches

        each of the elements of `ids`, then an error is returned.

        This cannot be provided together with the `name` or `names` query parameters.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Node_names:
      name: node_names
      in: query
      description: 'A comma-separated list of node names.

        If there is not at least one resource that matches each of the

        elements of `node_names`, then an error is returned.

        This cannot be provided in conjunction with the `node_ids`

        parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Sort:
      name: sort
      in: query
      description: 'Sort the response by the specified fields (in descending order if ''-''

        is appended to the field name).

        NOTE: If you provide a sort you will not get a `continuation_token` in

        the response.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          pattern: ^[a-z]+(_[a-z]+)*-?
          type: string
    Node_group_ids:
      name: node_group_ids
      in: query
      description: 'A comma-separated list of node group ids.

        If there is not at least one resource that matches each of the

        elements of `node_group_ids`, then an error is returned.

        This cannot be provided in conjunction with the `node_group_names` parameter.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
  schemas:
    Member:
      type: object
      properties:
        group:
          description: 'A reference to a group object that has the referenced member object

            as a member.

            '
          title: Reference
          allOf:
          - $ref: '#/components/schemas/_reference'
        member:
          description: 'A reference to an object that is a member of the referenced group.

            '
          title: Reference
          allOf:
          - $ref: '#/components/schemas/_reference'
    _referenceNameOnly:
      type: object
      properties:
        name:
          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
        resource_type:
          description: 'Type of the object (full name of the endpoint).

            Valid values are `hosts`, `host-groups`, `network-interfaces`, `pods`,

            `ports`, `pod-replica-links`, `subnets`, `volumes`, `volume-snapshots`,

            `volume-groups`, `directories`, `policies/nfs`, `policies/smb`, and

            `policies/snapshot`, etc.

            '
          type: string
          readOnly: true
      x-aliases:
      - _referenceWithFixedType
    _fixedReferenceWithoutType:
      type: object
      properties:
        id:
          description: 'A globally unique, system-generated ID.

            The ID cannot be modified.

            '
          type: string
          readOnly: true
        name:
          description: 'The resource name, such as volume name, file system name,

            snapshot name, and so on.

            '
          type: string
          readOnly: true
      x-readOnly: true
    NodeGroup:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
    NodeGroupUse:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - type: object
        properties:
          use:
            description: A reference to an object using this node group.
            title: FixedReference
            allOf:
            - $ref: '#/components/schemas/_fixedReference'
    _builtIn:
      type: object
      properties:
        id:
          description: 'A non-modifiable, globally unique ID chosen by the system.

            '
          type: string
          readOnly: true
        name:
          description: Name of the object (e.g., a file system or snapshot).
          type: string
          readOnly: true
    NodeGroupNodeGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/NodeGroupNodeResponse'
    NodeGroupPatch:
      allOf:
      - $ref: '#/components/schemas/_referenceNameOnly'
    NodeGroupNodeResponse:
      type: object
      properties:
        items:
          description: 'A list of node and node group relationships.

            '
          type: array
          items:
            $ref: '#/components/schemas/Member'
    NodeGroupGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/NodeGroupResponse'
    NodeGroupResponse:
      type: object
      properties:
        items:
          description: A list of node group objects.
          type: array
          items:
            $ref: '#/components/schemas/NodeGroup'
    _fixedReference:
      allOf:
      - $ref: '#/components/schemas/_fixedReferenceWithoutType'
      - type: object
        properties:
          resource_type:
            description: 'Type of the object (full name of the endpoint).

              Valid values are the unique part of the resource''s REST endpoint.

              For example, a reference to a file system would have a

              `resource_type` of `file-systems`.

              '
            type: string
            readOnly: true
    NodeGroupUseGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - type: object
        properties:
          items:
            description: A list of node group use objects.
            type: array
            items:
              $ref: '#/components/schemas/NodeGroupUse'
    PageInfo:
      type: object
      properties:
        continuation_token:
          description: 'Continuation token that can be provided in the `continuation_token` query

            param to get the next page of data.

            If you use the `continuation_token` to page through data you

            are guaranteed to get all items exactly once regardless of

            how items are modified. If an item is added or deleted during

            the pagination then it may or may not be returned.

            The `continuation_token` is generated if the `limit` is less

            than the remaining number of items, and the default sort is used

            (no sort is specified).

            '
          type: string
        total_item_count:
          description: Total number of items after applying `filter` params.
          type: integer
          format: int32