Pure Storage Subnets API

openapi: 3.2.0
info:
  title: FlashArray REST Active Directory Subnets 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: Subnets
  description: 'Manages the subnets and VLANs used to organize the network interfaces.

    '
paths:
  /api/2.52/subnets:
    get:
      tags:
      - Subnets
      summary: Pure Storage List Subnets
      description: Displays a list of subnets with statuses and attributes.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $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/SubnetGetResponse'
    post:
      tags:
      - Subnets
      summary: Pure Storage Create Subnet
      description: Creates a subnet with the specified parameters.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names_required'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubnetPost'
        required: true
        x-codegen-request-body-name: subnet
      responses:
        '200':
          description: Displays the newly created subnet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubnetResponse'
      x-codegen-request-body-name: subnet
    delete:
      tags:
      - Subnets
      summary: Pure Storage Delete Subnet
      description: 'Deletes subnets. A subnet can only be deleted if it has no interfaces. Interfaces must be

        removed by using the `network-interfaces` endpoint.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      responses:
        '200':
          description: OK
          content: {}
    patch:
      tags:
      - Subnets
      summary: Pure Storage Modify Subnet
      description: Modifies one or more specified subnet properties.
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubnetPatch'
        required: true
        x-codegen-request-body-name: subnet
      responses:
        '200':
          description: Displays the updated subnet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubnetResponse'
      x-codegen-request-body-name: subnet
  /api/2.26/subnets:
    get:
      tags:
      - Subnets
      summary: Pure Storage GET Subnets
      description: List the array’s subnets.
      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_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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubnetGetResponse'
    post:
      tags:
      - Subnets
      summary: Pure Storage POST Subnets
      description: Create an array subnet.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Names_required_2'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subnet_2'
        required: true
        x-codegen-request-body-name: subnet
      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/SubnetResponse_2'
      x-codegen-request-body-name: subnet
    delete:
      tags:
      - Subnets
      summary: Pure Storage DELETE Subnets
      description: Remove an array subnet.
      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: {}
    patch:
      tags:
      - Subnets
      summary: Pure Storage PATCH Subnets
      description: Modify array subnet attributes.
      parameters:
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Ids'
      - $ref: '#/components/parameters/Names'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subnet_2'
        required: true
        x-codegen-request-body-name: subnet
      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/SubnetResponse_2'
      x-codegen-request-body-name: subnet
components:
  schemas:
    SubnetResponse_2:
      type: object
      properties:
        items:
          description: A list of subnet objects.
          type: array
          items:
            $ref: '#/components/schemas/Subnet_2'
    Subnet:
      allOf:
      - $ref: '#/components/schemas/_resourceNoId'
      - $ref: '#/components/schemas/SubnetPost'
      - type: object
        properties:
          interfaces:
            description: List of network interfaces associated with this subnet.
            type: array
            readOnly: true
            items:
              $ref: '#/components/schemas/_fixedReferenceNoId'
          services:
            description: The services provided by this subnet, as inherited from all of its interfaces.
            type: array
            readOnly: true
            items:
              type: string
              description: 'Valid values are `iscsi`, `management`, `nvme/fc`, `nvme/roce`, and `replication`.

                '
    _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
    SubnetGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/SubnetResponse'
    _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
    _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
    SubnetPatch:
      allOf:
      - $ref: '#/components/schemas/_resourceNoId'
      - $ref: '#/components/schemas/SubnetPost'
    _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
    _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
    _fixedReferenceNoId:
      type: object
      properties:
        name:
          description: 'The resource name,

            such as volume name, pod name, snapshot name, and so on.

            '
          type: string
          readOnly: true
      x-readOnly: true
    SubnetPost:
      type: object
      properties:
        enabled:
          description: 'Returns a value of `true` if subnet is enabled.

            Returns a value of `false` if subnet is disabled.

            If not specified, defaults to `true`.

            '
          type: boolean
        gateway:
          description: 'The IPv4 or IPv6 address of the gateway through which the specified

            subnet is to communicate with the network.

            '
          type: string
        mtu:
          description: 'Maximum message transfer unit (packet) size for the subnet in bytes.

            MTU setting cannot exceed the MTU of the corresponding physical interface.

            If not specified, defaults to `1500`.

            '
          type: integer
          format: int32
          minimum: 1280
          maximum: 9216
        prefix:
          description: 'The IPv4 or IPv6 address to be associated with the specified subnet.

            '
          type: string
        vlan:
          description: VLAN ID number.
          type: integer
          format: int32
    Subnet_2:
      allOf:
      - $ref: '#/components/schemas/_builtIn'
      - type: object
        properties:
          enabled:
            description: 'Indicates if subnet is enabled (`true`) or disabled (`false`).

              If not specified, defaults to `true`.

              '
            type: boolean
            readOnly: true
          gateway:
            description: 'The IPv4 or IPv6 address of the gateway through which the specified

              subnet is to communicate with the network.

              '
            type: string
          interfaces:
            description: List of network interfaces associated with this subnet.
            type: array
            readOnly: true
            items:
              $ref: '#/components/schemas/_fixedReference'
          link_aggregation_group:
            description: Reference to the associated LAG.
            title: Reference
            allOf:
            - $ref: '#/components/schemas/_reference'
          mtu:
            description: 'Maximum message transfer unit (packet) size for the subnet in bytes.

              MTU setting cannot exceed the MTU of the corresponding physical

              interface. If not specified, defaults to `1500`.

              '
            type: integer
            format: int32
            minimum: 1280
            maximum: 9216
          prefix:
            description: 'The IPv4 or IPv6 address to be associated with the specified subnet.

              '
            type: string
            example: 1.2.3.0/24
          services:
            description: 'The services provided by this subnet, as inherited from all of its

              interfaces.

              '
            type: array
            readOnly: true
            items:
              type: string
              description: 'Valid values are `data`, `management`, `replication`, and `support`.

                '
          vlan:
            description: VLAN ID.
            type: integer
            format: int32
    SubnetResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Subnet'
    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
        more_items_remaining:
          description: 'Returns a value of `true` if subsequent items can be retrieved.

            '
          type: boolean
          example: false
        total_item_count:
          description: 'The total number of records after applying all filter query parameters.

            The `total_item_count` will be calculated if and only if the corresponding

            query parameter `total_item_count` is set to `true`. If this query parameter

            is not set or set to `false`, a value of `null` will be returned.

            '
          type: integer
          format: int32
  parameters:
    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
    Offset:
      name: offset
      in: query
      description: 'The starting position based on the results of the query

        in relation to the full set of response objects returned.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
      example: 10
    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
    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
    Offset_2:
      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
    Names_required:
      name: names
      in: query
      description: 'Performs the operation on the unique name specified.

        For example, `name01`.

        Enter multiple names in comma-separated format.

        '
      required: true
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Names_required_2:
      name: names
      in: query
      description: 'A comma-separated list of resource names.

        '
      required: true
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
    Total_item_count:
      name: total_item_count
      in: query
      description: 'If set to `true`, the `total_item_count` matching the

        specified query parameters is calculated and returned in

        the response. If set to `false`, the `total_item_count`

        is `null` in the response. This may speed up queries

        where the `total_item_count` is large. If not specified,

        defaults to `false`.

        '
      schema:
        type: boolean
    Filter:
      name: filter
      in: query
      description: 'Narrows down the results to only the response objects

        that satisfy the filter criteria.

        '
      schema:
        type: string
    Authorization:
      name: Authorization
      in: header
      description: 'Access token (in JWT format) required to use any API

        endpoint (except `/oauth2`, `/login`, and `/logout`)

        '
      schema:
        type: string
    Sort_2:
      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
    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
    XRequestId:
      name: X-Request-ID
      in: header
      description: 'Supplied by client during request or generated by server.

        '
      schema:
        type: string
    Sort:
      name: sort
      in: query
      description: "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n"
      style: form
      explode: false
      schema:
        type: array
        items:
          pattern: ^[a-z]+(_[a-z]+)*-?
          type: string