{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Arrays API", "version": "2.52" }, "items": [ { "info": { "name": "Arrays", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Arrays", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays general array properties including the array name, login banner,\nidle timeout for management sessions, and NTP servers.\n" }, { "info": { "name": "Pure Storage Modify an Array", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/arrays", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies general array properties such as the array name, login banner, idle timeout for\nmanagement sessions, and NTP servers.\n" }, { "info": { "name": "Pure Storage Delete an Array", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/arrays", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "eradicate_all_data", "value": "", "type": "query", "description": "Set to `true` to perform a factory reset.\n" }, { "name": "factory_reset_token", "value": "", "type": "query", "description": "A token required to perform a factory reset.\n" } ] }, "docs": "Deletes an array. For physical appliances, deleting an array restores the hardware to factory\nsettings. This entails deleting all data, metadata, configuration, and logs. The array returns\nto the state it was in prior to any configuration changes being made. If the hardware is reused,\nit must be as a different array with a new ID.\nFor virtual appliances, deleting an array puts it into an unusable state.\nVirtual resources (e.g., virtual machines) can later be freed, which deletes any remaining da" }, { "info": { "name": "Pure Storage DIMM Cache Status", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/cache", "params": [ { "name": "end_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The number of milliseconds between samples of historical data.\nFor array-wide performance metrics (`/arrays/performance` endpoint),\nvalid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes),\n`1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor performance metrics on storage objects (`/performance` endpoint),\nsuch as volumes,\nvalid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes),\n`7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor space metrics, (`/space` endpoint),\nvalid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours),\n`28800000` (8 hours), and `86400000` (24 hours).\nInclude the `start_time` parameter to display the performance data\nstarting at the specified start time.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nInclude the `end_time` parameter to display the performance data until the specified end time.\nIf `end_time`is not specified, the end time will default to the current time.\nIf the `resolution` parameter is not specified\nbut either the `start_time` or `end_time` parameter is,\nthen `resolution` will default to the lowest valid resolution.\n" }, { "name": "start_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" } ] }, "docs": "The status of the DIMM cache." }, { "info": { "name": "Pure Storage List CBS Array Configuration Status", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/cloud-config", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays the configuration status of the CBS array, including the progress of the\nconfiguration upgrade. Requests for non-CBS arrays will receive an error response.\n" }, { "info": { "name": "Pure Storage Modify CBS Array Configuration", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/arrays/cloud-config", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the configuration of the CBS array. This should trigger a backend\nprocess that will upgrade the CBS array configuration. The array can be\nupgraded only to models defined by the supported configurations endpoint. When an\nexisting array upgrade request is in progress, any new request to upgrade\nthe array will receive an error response. For non-CBS arrays, this\nfeature is not supported and requests will receive an error response.\n" }, { "info": { "name": "Pure Storage List CBS Array Supported Upgrade Target Configs", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/cloud-config/supported-configs", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays the list of supported configurations to which the CBS array can be upgraded.\nRequests for non-CBS arrays will receive an error response.\n" }, { "info": { "name": "Pure Storage List CBS Array Capacity Status", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/cloud-capacity", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays the capacity status of the CBS array including the progress of the\ncapacity update. Requests for non-CBS arrays will receive an error response.\n" }, { "info": { "name": "Pure Storage Modify CBS Array Capacity", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/arrays/cloud-capacity", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the raw capacity of the CBS array. This should trigger a backend\nprocess that will update the CBS array capacity. The array capacity can be\nupdated only to values defined by the capacity steps endpoint.\nWhen an existing capacity update request is in progress, any new request to update\nof the capacity will receive an error response.\nFor non-CBS arrays, this feature is not supported and requests will receive an error response.\n" }, { "info": { "name": "Pure Storage List CBS Array Capacity Steps", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/cloud-capacity/supported-steps", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays the list of supported raw capacity sizes in bytes the CBS array can be\nupgraded to. Requests for non-CBS arrays will receive an error response.\n" }, { "info": { "name": "Pure Storage List User Tags on the Cloud.", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/cloud-provider-tags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays the list of user tags on deployed cloud resources of a CBS array." }, { "info": { "name": "Pure Storage Delete User Tags from the Cloud.", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/arrays/cloud-provider-tags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "keys", "value": "", "type": "query", "description": "A comma-separated list of tag keys.\n" } ] }, "docs": "Deletes user tags from deployed cloud resources of a CBS array." }, { "info": { "name": "Pure Storage Update User Tags on the Cloud.", "type": "http" }, "http": { "method": "PUT", "url": "/api/2.52/arrays/cloud-provider-tags/batch", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates users tags to deployed cloud resources of a CBS array." }, { "info": { "name": "Pure Storage List Factory Reset Details", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/erasures", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays a list of factory reset processes.\n" }, { "info": { "name": "Pure Storage Create a Process for Factory Reset", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/arrays/erasures", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "eradicate_all_data", "value": "", "type": "query", "description": "Set to `true` to perform a factory reset.\n" }, { "name": "preserve_configuration_data", "value": "", "type": "query", "description": "A comma-separated list of configuration data types to preserve.\nA value of `all` will preserve all configuration\ndata types. Valid values include `all`.\n" }, { "name": "skip_phonehome_check", "value": "", "type": "query", "description": "A flag to skip phonehome connectivity check. If `skip_phonehome_check` is not set,\nthe factory reset will fail if phonehome connectivity check fails.\nArrays that intentionally disable phonehome or do not permit connectivity\nto Pure Storage's cloud servers must set this flag to `true` in order to start factory reset.\n" } ] }, "docs": "Creates the initiation of the factory reset process\n\n" }, { "info": { "name": "Pure Storage Update Factory Reset", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/arrays/erasures", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "delete_sanitization_certificate", "value": "", "type": "query", "description": "Set to `true` to finalize factory reset and acknowledge the deletion of sanitization certificate.\n" }, { "name": "eradicate_all_data", "value": "", "type": "query", "description": "Set to `true` to perform a factory reset.\n" }, { "name": "finalize", "value": "", "type": "query", "description": "Must be `true` to finalize factory reset.\n" }, { "name": "reinstall_image", "value": "", "type": "query", "description": "Set to `true` to reinstall image, or `false` to skip reinstalling image.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the factory reset process to finalize.\n\n" }, { "info": { "name": "Pure Storage Delete Factory Reset", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/arrays/erasures", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ] }, "docs": "Deletes the factory reset process when it is `failed`.\n\n" }, { "info": { "name": "Pure Storage List End User Agreement and Signature", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/eula", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays the End User Agreement and signature." }, { "info": { "name": "Pure Storage Modify Signature on the End User Agreement", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/arrays/eula", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the signature on the End User Agreement." }, { "info": { "name": "Pure Storage List Factory Reset Tokens", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/factory-reset-token", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays a list of tokens used to perform a factory reset on the array." }, { "info": { "name": "Pure Storage Create a Factory Reset Token", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/arrays/factory-reset-token", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ] }, "docs": "Creates a token that can be used to perform a factory reset on the array.\nFactory reset tokens can only be created after the array has been prepared\nfor reset (e.g., all volumes and snapshots must first be eradicated).\nAfter a token has been created, operations that would take the array out of\nthe prepared state are disabled (e.g., creating volumes) until all\ntokens have been deleted.\n\n" }, { "info": { "name": "Pure Storage Delete a Factory Reset Token", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/arrays/factory-reset-token", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ] }, "docs": "Deletes an existing token that could be used to perform a factory reset on the array." }, { "info": { "name": "Pure Storage List NTP Test Results", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/ntp-test", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ] }, "docs": "Displays test results for configured NTP servers." }, { "info": { "name": "Pure Storage List Array Front-end Performance Data", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/performance", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "end_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "protocol", "value": "", "type": "query", "description": "Protocol type. Valid values are `nfs`, `smb`, `s3`, and `all`.\n" }, { "name": "protocol_group", "value": "", "type": "query", "description": "Protocol group type. Valid values are `block`, `file`, `object-store`, and `all`.\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The number of milliseconds between samples of historical data.\nFor array-wide performance metrics (`/arrays/performance` endpoint),\nvalid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes),\n`1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor performance metrics on storage objects (`/performance` endpoint),\nsuch as volumes,\nvalid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes),\n`7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor space metrics, (`/space` endpoint),\nvalid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours),\n`28800000` (8 hours), and `86400000` (24 hours).\nInclude the `start_time` parameter to display the performance data\nstarting at the specified start time.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nInclude the `end_time` parameter to display the performance data until the specified end time.\nIf `end_time`is not specified, the end time will default to the current time.\nIf the `resolution` parameter is not specified\nbut either the `start_time` or `end_time` parameter is,\nthen `resolution` will default to the lowest valid resolution.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "start_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays real-time and historical front-end performance data at the array\nlevel including latency, bandwidth, IOPS, average I/O size, and queue depth.\n\n" }, { "info": { "name": "Pure Storage List Array Front-end IO Performance Data by Link", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/performance/by-link", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "end_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The number of milliseconds between samples of historical data.\nFor array-wide performance metrics (`/arrays/performance` endpoint),\nvalid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes),\n`1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor performance metrics on storage objects (`/performance` endpoint),\nsuch as volumes,\nvalid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes),\n`7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor space metrics, (`/space` endpoint),\nvalid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours),\n`28800000` (8 hours), and `86400000` (24 hours).\nInclude the `start_time` parameter to display the performance data\nstarting at the specified start time.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nInclude the `end_time` parameter to display the performance data until the specified end time.\nIf `end_time`is not specified, the end time will default to the current time.\nIf the `resolution` parameter is not specified\nbut either the `start_time` or `end_time` parameter is,\nthen `resolution` will default to the lowest valid resolution.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "start_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays real-time and historical front-end performance data at the array\nlevel including latency, bandwidth, IOPS, average I/O size, and queue depth.\nGroup output is shown by link. A link represents a set of arrays that an I/O operation\ndepends on.\nFor local-only I/Os, this is a local array. For mirrored I/Os, this is a set of synchronous\nreplication peer arrays.\n\n" }, { "info": { "name": "Pure Storage List Array Space Information", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/space", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "end_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The number of milliseconds between samples of historical data.\nFor array-wide performance metrics (`/arrays/performance` endpoint),\nvalid values are `1000` (1 second), `30000` (30 seconds), `300000` (5 minutes),\n`1800000` (30 minutes), `7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor performance metrics on storage objects (`/performance` endpoint),\nsuch as volumes,\nvalid values are `30000` (30 seconds), `300000` (5 minutes), `1800000` (30 minutes),\n`7200000` (2 hours), `28800000` (8 hours), and `86400000` (24 hours).\nFor space metrics, (`/space` endpoint),\nvalid values are `300000` (5 minutes), `1800000` (30 minutes), `7200000` (2 hours),\n`28800000` (8 hours), and `86400000` (24 hours).\nInclude the `start_time` parameter to display the performance data\nstarting at the specified start time.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nInclude the `end_time` parameter to display the performance data until the specified end time.\nIf `end_time`is not specified, the end time will default to the current time.\nIf the `resolution` parameter is not specified\nbut either the `start_time` or `end_time` parameter is,\nthen `resolution` will default to the lowest valid resolution.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "start_time", "value": "", "type": "query", "description": "Displays historical performance data for the specified time window,\nwhere `start_time` is the beginning of the time window,\nand `end_time` is the end of the time window.\nThe `start_time` and `end_time` parameters\nare specified in milliseconds since the UNIX epoch.\nIf `start_time` is not specified,\nthe start time will default to one resolution before the end time,\nmeaning that the most recent sample of performance data will be displayed.\nIf `end_time`is not specified, the end time will default to the current time.\nInclude the `resolution` parameter to display the performance data at the specified resolution.\nIf not specified, `resolution` defaults to the lowest valid resolution.\n\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays real-time and historical array space information including unique\nvolume and snapshot space, shared space, data reduction, provisioned\ncapacity, usable capacity, and parity.\n\n" }, { "info": { "name": "Pure Storage List Tags", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/arrays/tags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "namespaces", "value": "", "type": "query", "description": "A comma-separated list of namespaces.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "sort", "value": "", "type": "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" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\n" } ] }, "docs": "Displays the list of tags on array objects.\n" }, { "info": { "name": "Pure Storage Delete Tags", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/arrays/tags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" }, { "name": "keys", "value": "", "type": "query", "description": "A comma-separated list of tag keys.\n" }, { "name": "namespaces", "value": "", "type": "query", "description": "A comma-separated list of namespaces.\n" } ] }, "docs": "Deletes specified tags on array objects.\n" }, { "info": { "name": "Pure Storage Update Tags", "type": "http" }, "http": { "method": "PUT", "url": "/api/2.52/arrays/tags/batch", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the context specified.\n\nIf specified, the context names must be an array of size 1, and the single element\nmust be the name of an array in the same fleet or the name of the fleet itself. If\nnot specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates tags.\n" }, { "info": { "name": "Pure Storage GET Arrays", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "List array attributes such as the array name, ID, version, and NTP servers." }, { "info": { "name": "Pure Storage PATCH Arrays", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/arrays", "headers": [ { "name": "X-Request-ID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the general configuration of the array including banner text, array name, NTP servers, and time zone." }, { "info": { "name": "Pure Storage GET Arrays/eula", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/eula", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "List the End User Agreement and signature." }, { "info": { "name": "Pure Storage PATCH Arrays/eula", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/arrays/eula", "headers": [ { "name": "X-Request-ID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the signature on the End User Agreement." }, { "info": { "name": "Pure Storage List Factory Reset Tokens", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/factory-reset-token", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "Displays a list of tokens used to perform a factory reset on the array." }, { "info": { "name": "Pure Storage Create a Factory Reset Token", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/arrays/factory-reset-token", "headers": [ { "name": "X-Request-ID", "value": "" } ] }, "docs": "Creates a token that can be used to perform a factory reset on the array.\nFactory reset tokens can only be created after the array has been prepared\nfor reset (e.g., all file systems, buckets, and snapshots must first be eradicated).\nAfter a token has been created, operations that would take the array out of\nthe prepared state (e.g., creating file systems) are disabled until all\ntokens have been deleted.\n" }, { "info": { "name": "Pure Storage Delete a Factory Reset Token", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/arrays/factory-reset-token", "headers": [ { "name": "X-Request-ID", "value": "" } ] }, "docs": "Deletes any existing token that could be used to perform a factory reset on the array.\n" }, { "info": { "name": "Pure Storage GET Arrays/http-specific-performance", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/http-specific-performance", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "end_time", "value": "1514764800000", "type": "query", "description": "When the time window ends (in milliseconds since epoch).\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The desired ms between samples. Available resolutions may\ndepend on data type, `start_time` and `end_time`.\nIn general `1000`, `30000`, `300000`, `1800000`, `7200000`, and\n`86400000` are possible values.\n" }, { "name": "start_time", "value": "1514764800000", "type": "query", "description": "When the time window starts (in milliseconds since epoch).\n" } ] }, "docs": "List the HTTP performance metrics of the array." }, { "info": { "name": "Pure Storage GET Arrays/nfs-specific-performance", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/nfs-specific-performance", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "end_time", "value": "1514764800000", "type": "query", "description": "When the time window ends (in milliseconds since epoch).\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The desired ms between samples. Available resolutions may\ndepend on data type, `start_time` and `end_time`.\nIn general `1000`, `30000`, `300000`, `1800000`, `7200000`, and\n`86400000` are possible values.\n" }, { "name": "start_time", "value": "1514764800000", "type": "query", "description": "When the time window starts (in milliseconds since epoch).\n" } ] }, "docs": "List the NFS performance metrics of the array." }, { "info": { "name": "Pure Storage GET Arrays/performance", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/performance", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "end_time", "value": "1514764800000", "type": "query", "description": "When the time window ends (in milliseconds since epoch).\n" }, { "name": "protocol", "value": "", "type": "query", "description": "Display the performance of a specified protocol.\nValid values are `all`, `HTTP`, `SMB`, `NFS`, and `S3`.\nIf not specified, defaults to `all`, which will provide\nthe combined performance of all available protocols.\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The desired ms between samples. Available resolutions may\ndepend on data type, `start_time` and `end_time`.\nIn general `1000`, `30000`, `300000`, `1800000`, `7200000`, and\n`86400000` are possible values.\n" }, { "name": "start_time", "value": "1514764800000", "type": "query", "description": "When the time window starts (in milliseconds since epoch).\n" } ] }, "docs": "Lists the overall performance metrics of the array." }, { "info": { "name": "Pure Storage GET Arrays/performance/replication", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/performance/replication", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "end_time", "value": "1514764800000", "type": "query", "description": "When the time window ends (in milliseconds since epoch).\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The desired ms between samples. Available resolutions may\ndepend on data type, `start_time` and `end_time`.\nIn general `1000`, `30000`, `300000`, `1800000`, `7200000`, and\n`86400000` are possible values.\n" }, { "name": "start_time", "value": "1514764800000", "type": "query", "description": "When the time window starts (in milliseconds since epoch).\n" }, { "name": "type", "value": "", "type": "query", "description": "Display the metric of a specified object type.\nValid values are `all`, `file-system`, and `object-store`.\nIf not specified, defaults to `all`.\n" } ] }, "docs": "List replication performance metrics." }, { "info": { "name": "Pure Storage GET Arrays/s3-specific-performance", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/s3-specific-performance", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "end_time", "value": "1514764800000", "type": "query", "description": "When the time window ends (in milliseconds since epoch).\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The desired ms between samples. Available resolutions may\ndepend on data type, `start_time` and `end_time`.\nIn general `1000`, `30000`, `300000`, `1800000`, `7200000`, and\n`86400000` are possible values.\n" }, { "name": "start_time", "value": "1514764800000", "type": "query", "description": "When the time window starts (in milliseconds since epoch).\n" } ] }, "docs": "List the S3 performance metrics of the array." }, { "info": { "name": "Pure Storage GET Arrays/space", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/space", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "end_time", "value": "1514764800000", "type": "query", "description": "When the time window ends (in milliseconds since epoch).\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The desired ms between samples. Available resolutions may\ndepend on data type, `start_time` and `end_time`.\nIn general `1000`, `30000`, `300000`, `1800000`, `7200000`, and\n`86400000` are possible values.\n" }, { "name": "start_time", "value": "1514764800000", "type": "query", "description": "When the time window starts (in milliseconds since epoch).\n" }, { "name": "type", "value": "", "type": "query", "description": "Display the metric of a specified object type.\nValid values are `array`, `file-system`, and `object-store`.\nIf not specified, defaults to `array`.\n" } ] }, "docs": "List available and used storage space on the array." }, { "info": { "name": "Pure Storage GET Arrays/space/storage-classes", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/space/storage-classes", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "end_time", "value": "1514764800000", "type": "query", "description": "When the time window ends (in milliseconds since epoch).\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "resolution", "value": "30000", "type": "query", "description": "The desired ms between samples. Available resolutions may\ndepend on data type, `start_time` and `end_time`.\nIn general `1000`, `30000`, `300000`, `1800000`, `7200000`, and\n`86400000` are possible values.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" }, { "name": "start_time", "value": "1514764800000", "type": "query", "description": "When the time window starts (in milliseconds since epoch).\n" }, { "name": "storage_class_names", "value": "", "type": "query", "description": "A comma-separated list of storage class names. Valid values include `S500X-S` and `S500X-A`.\n" }, { "name": "total_only", "value": "", "type": "query", "description": "If set to `true`, returns the aggregate value of all items after filtering.\nWhere it makes more sense, the average value is displayed instead.\nThe values are displayed for each name where meaningful.\nIf `total_only=true`, the `items` list will be empty.\n" } ] }, "docs": "List available and used storage space for storage classes on the array." }, { "info": { "name": "Pure Storage GET Arrays/supported-time-zones", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/supported-time-zones", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "limit", "value": "10", "type": "query", "description": "Limits the size of the response to the specified number of objects on each page.\nTo return the total number of resources, set `limit=0`.\nThe total number of resources is returned as a `total_item_count` value.\nIf the page size requested is larger than the system maximum limit,\nthe server returns the maximum limit, disregarding the requested page size.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n\nIf there is not at least one resource that matches\neach of the elements of `names`, then an error is returned,\nexcept when creating new resources.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "List supported time zones for the array." }, { "info": { "name": "Pure Storage Get Factory Reset Status", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/arrays/erasures", "headers": [ { "name": "X-Request-ID", "value": "" } ] }, "docs": "Get the factory reset process status.\n" }, { "info": { "name": "Pure Storage Create a Process for Factory Reset", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/arrays/erasures", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "eradicate_all_data", "value": "", "type": "query", "description": "Set to `true` to perform a factory reset.\n" }, { "name": "preserve_configuration_data", "value": "", "type": "query", "description": "For the initial phase `none` is only acceptable value for this parameter\n" }, { "name": "skip_phonehome_check", "value": "", "type": "query", "description": "A flag to skip phonehome connectivity check.\nArrays that intentionally disable phonehome or do not permit connectivity\nto Pure Storage's cloud servers must set this flag to `true` in order to start factory reset.\n" } ] }, "docs": "Creates the initiation of the factory reset process.\n\n" }, { "info": { "name": "Pure Storage Factory Reset - Finalize", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/arrays/erasures", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "delete_sanitization_certificate", "value": "", "type": "query", "description": "Must be `true` to finalize factory reset and acknowledge the deletion of sanitization certificate.\n" }, { "name": "eradicate_all_data", "value": "", "type": "query", "description": "Set to `true` to perform a factory reset.\n" }, { "name": "finalize", "value": "", "type": "query", "description": "Must be `true` to finalize factory reset.\n" } ] }, "docs": "After the process has been completed, we need to finalize the factory reset process.\n\n" }, { "info": { "name": "Pure Storage Stop Factory Reset", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/arrays/erasures", "headers": [ { "name": "X-Request-ID", "value": "" } ] }, "docs": "Stops the factory reset process when it is `failed`.\n\n" }, { "info": { "name": "Pure Storage Get Arrays", "type": "http" }, "http": { "method": "GET", "url": "/api/1.5/arrays", "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": "fqdns", "value": "", "type": "query", "description": "A comma-separated list of resource FQDNs.\nIf there is not at least one resource that matches each `fqdn` element,\nan error is returned.\nSingle quotes are required around all strings.\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": "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 FlashArray and FlashBlade storage appliances.\n" }, { "info": { "name": "Pure Storage Get Array Support Contracts", "type": "http" }, "http": { "method": "GET", "url": "/api/1.5/arrays/support-contracts", "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": "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": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "resource_fqdns", "value": "", "type": "query", "description": "A comma-separated list of resource FQDNs.\nIf there is not at least one resource that matches each `resource_fqdn`\nelement, an error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "resource_ids", "value": "", "type": "query", "description": "A 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": "A 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": "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 the support contracts associated with arrays.\n" }, { "info": { "name": "Pure Storage Get Array Tags", "type": "http" }, "http": { "method": "GET", "url": "/api/1.5/arrays/tags", "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": "keys", "value": "", "type": "query", "description": "A comma-separated list of tag keys.\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": "namespaces", "value": "", "type": "query", "description": "A comma-separated list of namespaces.\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_ids", "value": "", "type": "query", "description": "A 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": "A 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" } ] }, "docs": "Retrieves the tags associated with specified arrays.\n" }, { "info": { "name": "Pure Storage Delete Array Tags", "type": "http" }, "http": { "method": "DELETE", "url": "/api/1.5/arrays/tags", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "keys", "value": "", "type": "query", "description": "A comma-separated list of tag keys.\nSingle quotes are required around all strings.\n" }, { "name": "namespaces", "value": "", "type": "query", "description": "A comma-separated list of namespaces.\nSingle quotes are required around all strings.\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" } ] }, "docs": "Deletes array tags from Pure1.\n" }, { "info": { "name": "Pure Storage Create or Update Array Tags", "type": "http" }, "http": { "method": "PUT", "url": "/api/1.5/arrays/tags/batch", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "namespaces", "value": "", "type": "query", "description": "A comma-separated list of namespaces.\nSingle quotes are required around all strings.\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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates array tags contextual to Pure1 only.\n" } ] } ], "bundled": true }