{
  "opencollection": "1.0.0",
  "info": {
    "name": "FlashArray REST Active Directory Metrics API",
    "version": "2.52"
  },
  "items": [
    {
      "info": {
        "name": "Metrics",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Pure Storage Get Metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/1.5/metrics",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "continuation_token",
                "value": "",
                "type": "query",
                "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "A comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset of the first resource to return from a collection.\n"
              },
              {
                "name": "resource_types",
                "value": "",
                "type": "query",
                "description": "The resource types to list the available metrics.\nValid values are `arrays`, `buckets`, `directories`,\n`file-systems`, `pods`, `subscription-licenses` and\n`volumes`.\nA metric can belong to a combination of resources,\ne.g., write-iops from array to pod. In that case, query by\n['arrays', 'pods'].\nSingle quotes are required around all strings.\n"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n"
              }
            ]
          },
          "docs": "Retrieves information about metrics that can be queried for.\n"
        },
        {
          "info": {
            "name": "Pure Storage Get Metrics History",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/1.5/metrics/history",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Request-ID",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "aggregation",
                "value": "",
                "type": "query",
                "description": "Aggregation needed on the metric data.\nValid values are `avg` and `max`.\nSingle quotes are required around all strings.\nLatency metrics averages are weighted by the IOPS.\n"
              },
              {
                "name": "end_time",
                "value": "",
                "type": "query",
                "description": "Timestamp of when the time window ends. Measured in milliseconds since the UNIX epoch.\n"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "REQUIRED: either `ids` or `names`.\nA comma-separated list of object IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n"
              },
              {
                "name": "names",
                "value": "",
                "type": "query",
                "description": "REQUIRED: either `names` or `ids`.\nA comma-separated list of resource names.\nIf there is not at least one resource that matches each `name` element,\nan error is returned.\nSingle quotes are required around all strings.\n"
              },
              {
                "name": "resolution",
                "value": "",
                "type": "query",
                "description": "The duration of time between individual data points, in milliseconds.\n"
              },
              {
                "name": "resource_ids",
                "value": "",
                "type": "query",
                "description": "REQUIRED: either `resource_ids` or `resource_names`.\nA comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `resource_id` element,\nan error is returned.\nSingle quotes are required around all strings.\n"
              },
              {
                "name": "resource_names",
                "value": "",
                "type": "query",
                "description": "REQUIRED: either `resource_ids` or `resource_names`.\nA comma-separated list of resource names.\nIf there is not at least one resource that matches each `resource_name`\nelement, an error is returned.\nSingle quotes are required around all strings.\n"
              },
              {
                "name": "start_time",
                "value": "",
                "type": "query",
                "description": "Timestamp of when the time window starts. Measured in milliseconds since the UNIX epoch.\n"
              }
            ]
          },
          "docs": "Retrieves historical metric data for resources.\nThis endpoint supports batching: Up to 32 time series can be retrieved in one call.\nIt can be multiple metrics for one resource,\n(e.g., load and bandwidth for one array - 2 time series),\none metric for multiple resource (e.g., load for arrayA and arrayB - 2 time series),\nor a combination of both, multiple metrics for multiple resources,\n(e.g., load and bandwidth for arrayA and arrayB - 4 time series).\n"
        }
      ]
    }
  ],
  "bundled": true
}