Pure Storage Sustainability API

openapi: 3.0.1
info:
  title: FlashArray REST Active Directory Sustainability 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: Sustainability
  description: 'Provides information about energy consumption and sustainability.

    '
paths:
  /api/1.5/assessment/sustainability/arrays:
    get:
      tags:
      - Sustainability
      summary: Pure Storage Get Appliance Sustainability Information.
      description: 'Retrieves information about FlashArray and FlashBlade size,

        power consumption, heat generation and its sustainability assessment.

        '
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/XRequestId'
      - $ref: '#/components/parameters/Continuation_token'
      - $ref: '#/components/parameters/Filter'
      - $ref: '#/components/parameters/Fqdns'
      - $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
            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/SustainabilityArrayGetResponse'
        '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'
  /api/1.5/assessment/sustainability/insights/arrays:
    get:
      tags:
      - Sustainability
      summary: Pure Storage Get Appliance Sustainability Insights Information.
      description: 'Retrieves information about FlashArray and FlashBlade insights

        connected to sustainability assessment.

        '
      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/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
            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/SustainabilityInsightArrayGetResponse'
        '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:
  responses:
    Error404:
      description: NOT FOUND
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

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

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error500:
      description: INTERNAL SERVER ERROR
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

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

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error403:
      description: FORBIDDEN
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorNoContext'
    Error400:
      description: BAD REQUEST
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

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

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error429:
      description: TOO MANY REQUESTS
      headers:
        X-Request-ID:
          description: Supplied by client during request or generated by server.
          schema:
            type: object
        X-RateLimit-Remaining-minute:
          description: 'The number of requests remaining for the organization in that minute.

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

            '
          schema:
            type: object
        X-RateLimit-Limit-minute:
          description: The number of requests available per minute.
          schema:
            type: object
        X-RateLimit-Limit-second:
          description: The number of requests available per second.
          schema:
            type: object
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorNoContext'
  schemas:
    SustainabilityArrayGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/SustainabilityArrayResponse'
    SustainabilityInsightArray:
      description: 'A single FlashArray/FlashBlade appliance Sustainability assessment insights information.

        The _as_of is the time when the computation happened.

        Only the data from the given time interval was used for the computation of insight.

        Typically the last week of data is used for the computation of insights.

        '
      allOf:
      - $ref: '#/components/schemas/_timeAware'
      - $ref: '#/components/schemas/_time_interval'
      - type: object
        properties:
          additional_data:
            description: 'The arbitrary data associated with the insight.

              '
            type: object
            readOnly: true
            example:
              required_version: 6.3.0
          resource:
            $ref: '#/components/schemas/_fixedReferenceFqdn'
          severity:
            description: 'The severity of the insight.

              Should be one of medium, high.

              '
            type: string
            readOnly: true
            example: medium
          type:
            description: 'The type of the insight.

              '
            type: string
            readOnly: true
            example: upgrade_purity_version_for_array_wide
    SustainabilityArrayResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SustainabilityArray'
    Error:
      type: object
      properties:
        errors:
          description: The list of errors encountered.
          type: array
          items:
            $ref: '#/components/schemas/_errorErrors'
    _timeAware:
      type: object
      properties:
        _as_of:
          description: The freshness of the data (timestamp in millis since epoch).
          type: integer
          format: int64
          readOnly: true
          example: 1502729489760
    ErrorNoContext:
      type: object
      properties:
        message:
          type: string
          example: Something was wrong
    _errorErrors:
      type: object
      properties:
        context:
          type: string
          example: Error with ...
        message:
          type: string
          example: Something was wrong
    _time_interval:
      type: object
      properties:
        _interval_end:
          description: The timestamp of the end of the time interval.
          type: integer
          format: int64
          readOnly: true
          example: 1502729489760
        _interval_start:
          description: The timestamp of the start of the time interval.
          type: integer
          format: int64
          readOnly: true
          example: 1501519889760
    SustainabilityInsightArrayResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SustainabilityInsightArray'
    SustainabilityAssessment:
      description: 'A FlashArray or FlashBlade Sustainability assessment information.

        The _as_of is the time when the computation happened.

        Only the data from the given time interval was used for the aggregation.

        Typically the last week of data is used for the aggregation.

        '
      allOf:
      - $ref: '#/components/schemas/_timeAware'
      - $ref: '#/components/schemas/_time_interval'
      - type: object
        properties:
          array_data_reduction:
            description: 'The data reduction ratio of the appliance.

              Average over the assessment window.

              '
            type: number
            readOnly: true
            example: 2.5
          array_total_load:
            description: 'The load percentage.

              Average over the assessment window.

              '
            type: number
            readOnly: true
            example: 0.23
          assessment_level:
            description: "The assessment level of an appliance. Valid values include:\ngood - The assessment level of appliance is GOOD - all green.\nrecommendation - There are some actions\n  that can be done to bring appliance to a GOOD level.\naction_required - The lowest level of assessment.\n  Some actions are required to improve the assessment level.\n"
            type: string
            readOnly: true
            example: good
          blades:
            description: 'The number of blades of the FlashBlade appliance, always zero for FlashArray appliances.

              '
            type: integer
            readOnly: true
            example: 15
          capacity_utilization:
            description: 'The percentage of the used capacity.

              Average over the assessment window.

              '
            type: number
            readOnly: true
            example: 0.68
          chassis:
            description: 'The number of chassis of the appliance, always one for FlashArray appliances.

              '
            type: integer
            readOnly: true
            example: 1
          heat_average:
            description: 'The average of heat production of the appliance in BTU/Hr.

              Average over the assessment window.

              '
            type: number
            readOnly: true
            example: 1787.69
          heat_peak_spec:
            description: 'The peak heat production of the appliance in BTU/hr.

              The value is derived from benchmark data and remains static for the model and configuration.

              '
            type: number
            readOnly: true
            example: 2046.0
          heat_typical_spec:
            description: 'The typical heat production of the appliance in BTU/hr.

              The value is derived from benchmark data and remains static for the model and configuration.

              '
            type: number
            readOnly: true
            example: 1705.0
          power_average:
            description: 'The average of power consumption of the appliance.

              Average over the assessment window.

              '
            type: number
            readOnly: true
            example: 524.25
          power_peak_spec:
            description: 'The peak power consumption of the appliance in Watts.

              The value is derived from benchmark data and remains static for the model and configuration.

              '
            type: number
            readOnly: true
            example: 600.0
          power_per_usable_capacity:
            description: The average of power consumption per TiB of usable capacity.
            type: number
            readOnly: true
            example: 5.4
          power_per_used_space:
            description: The average of power consumption per TiB of used space.
            type: number
            readOnly: true
            example: 22.5
          power_typical_spec:
            description: 'The typical power consumption of the appliance in Watts.

              The value is derived from benchmark data and remains static for the model and configuration.

              '
            type: number
            readOnly: true
            example: 500.0
          rack_units:
            description: The total number of rack units occupied by the appliance.
            type: integer
            readOnly: true
            example: 4
          shelves:
            description: 'The number of expansion shelves of the FlashArray appliance.

              It is always zero for FlashBlade appliances.

              '
            type: integer
            readOnly: true
            example: 1
    _install_address:
      type: object
      properties:
        geolocation:
          description: 'The geolocation that contains the latitude and the longitude of the address.

            '
          title: Geolocation
          allOf:
          - $ref: '#/components/schemas/_geolocation'
        street_address:
          description: The 1-line format street address of the array install address.
          type: string
          readOnly: true
          example: 599 Castro St, Mountain View, CA 94041 United States
        updated:
          description: 'The epoch timestamp, in milliseconds, that denotes when the address was updated.

            '
          type: integer
          readOnly: true
          example: 1548080949
    _fixedReferenceFqdn:
      allOf:
      - $ref: '#/components/schemas/_fixedReference'
      - type: object
        properties:
          fqdn:
            description: 'The fully qualified domain name of the appliance when `resource_type` is `arrays`,

              `null` otherwise.

              '
            type: string
            readOnly: true
            example: example_name.dc1.example.com
    _builtInAsOf:
      description: 'A built-in resource. Many are singletons predefined by Purity (e.g., support

        settings). Some correspond to a piece of software, like an app, or hardware,

        like a controller. Others are created by the system in response to some event

        (e.g., alerts, audit records).


        Typically, a user can''t create, delete or rename a built-in resource. A few

        can be created or deleted, but not renamed because the names are meaningful

        to Purity (e.g., VIFs).


        '
      allOf:
      - $ref: '#/components/schemas/_timeAware'
      - type: object
        properties:
          id:
            description: A non-modifiable, globally unique ID chosen by the system.
            type: string
            readOnly: true
            example: 01c2889a-4124-49ff-8cbd-c33405ede123
          name:
            description: A non-modifiable, locally unique name chosen by the system.
            type: string
            readOnly: true
            example: example_name
    _geolocation:
      type: object
      properties:
        latitude:
          description: The latitude of the address.
          type: number
          readOnly: true
          example: 23.234
        longitude:
          description: The longitude of the address.
          type: number
          readOnly: true
          example: 123.9834
    SustainabilityArray:
      description: 'A single FlashArray/FlashBlade appliance Sustainability assessment information.


        '
      allOf:
      - $ref: '#/components/schemas/_builtInAsOf'
      - type: object
        properties:
          assessment:
            $ref: '#/components/schemas/SustainabilityAssessment'
          install_address:
            description: 'The address where the array is installed. This address is also where

              replacement parts will be shipped to.

              '
            title: Install_address
            allOf:
            - $ref: '#/components/schemas/_install_address'
          reporting_status:
            description: "Enum value that describes what is the status of the latest assessment. Valid values include:\nnot_enough_data - There was not enough data\n  to calculate assessment level of the appliance.\nunsupported_purity_version - The appliance is running\n  an unsupported version of Purity operating system.\n  It is an old Purity version which does not provide\n  enough data for assessing the sustainability metrics.\nnot_phoning_home - The appliance has not phoned home\n  for more than 7 days so the assessment level was not calculated\nassessment_ready - Assessment is ready and it is available under `assessment` field.\n"
            type: string
            readOnly: true
            example: assessment_ready
    _fixedReference:
      type: object
      properties:
        id:
          description: The opaque and unique id of this resource.
          type: string
          readOnly: true
          example: 2a989a09-c851-4d52-9ec6-ab728b1c04db
        name:
          description: The name of this resource.
          type: string
          readOnly: true
          example: example_name
        resource_type:
          description: 'The type of this resource represented by the name of its REST endpoint.

            For example, "arrays", "network-interfaces", and "metrics".

            The value may be `null` if the resource is not represented.

            '
          type: string
          readOnly: true
          example: example_resource_type
      x-readOnly: true
    SustainabilityInsightArrayGetResponse:
      allOf:
      - $ref: '#/components/schemas/PageInfo'
      - $ref: '#/components/schemas/SustainabilityInsightArrayResponse'
    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
          example: MThkMzJmYWUtZDI3OS00ODEzLWIzODYtMmM3NmFhMTMwM2My
        total_item_count:
          description: Total number of items after applying filter params.
          type: integer
          format: int32
          example: 1
  parameters:
    Offset:
      name: offset
      in: query
      description: 'The offset of the first resource to return from a collection.

        '
      schema:
        type: integer
        format: int32
        minimum: 0
    Filter:
      name: filter
      in: query
      description: 'Exclude resources that don''t match the specified criteria.

        Single quotes are required around all strings inside the filters.

        '
      schema:
        type: string
    Continuation_token:
      name: continuation_token
      in: query
      description: 'An opaque token used to iterate over a collection.

        The token to use on the next request is returned in the

        `continuation_token` field of the result.

        Single quotes are required around all strings.

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

        '
      schema:
        type: string
    Limit:
      name: limit
      in: query
      description: 'Limit the size of the response to the specified number of resources.

        A limit of 0 can be used to get the number of resources without getting

        all of the resources. It will be returned in the total_item_count field.

        If a client asks for a page size larger than the maximum number, the request

        is still valid. In that case the server just returns the maximum number of

        items, disregarding the client''s page size request. If not specified, defaults

        to 1000.

        '
      schema:
        type: integer
        format: int32
    Authorization:
      name: Authorization
      in: header
      description: 'Access token (in JWT format) required to use any API endpoint (except `/oauth2`)

        '
      schema:
        type: string
    Names:
      name: names
      in: query
      description: 'A comma-separated list of resource names.

        If there is not at least one resource that matches each `name` element,

        an error is returned.

        Single quotes are required around all strings.

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

        If there is not at least one resource that matches each `id` element,

        an error is returned.

        Single quotes are required around all strings.

        '
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
        x-quoted: true
      x-quoted: true
    Fqdns:
      name: fqdns
      in: query
      description: 'A comma-separated list of resource FQDNs.

        If there is not at least one resource that matches each `fqdn` element,

        an error is returned.

        Single quotes are required around all strings.

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

        is appended to the field name).

        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