{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Volumes API", "version": "2.52" }, "items": [ { "info": { "name": "Volumes", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Volumes", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/volumes", "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": "destroyed", "value": "", "type": "query", "description": "If set to `true`, lists only destroyed objects that are in the eradication pending state.\nIf set to `false`, lists only objects that are not destroyed.\nIf not set, lists both objects that are destroyed and those that are not destroyed.\n\nFor destroyed objects, the time remaining is displayed in milliseconds.\n\nIf object name(s) or id(s) are specified, then each object referenced must exist.\nIf `destroyed` is set to `true`, then each object referenced must also be destroyed.\nIf `destroyed` is set to `false`, then each object referenced must also not be destroyed.\nAn error is returned if any of these conditions are not met.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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 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" }, { "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": "Displays a list of volumes, including those pending eradication.\n\n" }, { "info": { "name": "Pure Storage Create or Copy a Volume and Upsert Tags", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/volumes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "add_to_protection_group_ids", "value": "", "type": "query", "description": "The volumes will be added to the specified protection groups along with creation or movement\nacross pods and array.\nWhen a volume is moved, the specified protection groups must be in the target pod or array.\nEnter multiple ids in comma-separated format.\n" }, { "name": "add_to_protection_group_names", "value": "", "type": "query", "description": "The volumes will be added to the specified protection groups along with creation or movement\nacross pods and array.\nWhen a volume is moved, the specified protection groups must be in the target pod or array.\nEnter multiple names in a comma-separated format.\n" }, { "name": "allow_throttle", "value": "", "type": "query", "description": "If set to `true`, allows operation to fail if array health is not optimal.\n" }, { "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": "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": "overwrite", "value": "", "type": "query", "description": "If set to `true`,\noverwrites an existing object during an object copy operation.\nIf set to `false` or not set at all and the target name is an existing object,\nthe copy operation fails.\nRequired if the `source` body parameter is set\nand the source overwrites an existing object during the copy operation.\n" }, { "name": "with_default_protection", "value": "", "type": "query", "description": "If specified as `true`, the initial protection of the newly created volumes will be\nthe union of the container default protection configuration and\n`add_to_protection_group_names`.\nIf specified as `false`, the default protection of the container will not be applied\nautomatically. The initial protection of the newly created volumes will be configured\nby `add_to_protection_group_names`.\nIf not specified, defaults to `true`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates one or more virtual storage volumes of the specified size.\nIf `provisioned` is not specified, the size of the new volume defaults to 1 MB.\nThe `names` query parameter is required.\nThe `add_to_protection_group_names` query parameter specifies a list of protection group\nnames that will compose the initial protection for the volume.\nThe `with_default_protection` query parameter specifies whether to use the container\ndefault protection configuration for the volume.\nThe `add_to_protection_gro" }, { "info": { "name": "Pure Storage Modify a Volume", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/volumes", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "add_to_protection_group_ids", "value": "", "type": "query", "description": "The volumes will be added to the specified protection groups along with creation or movement\nacross pods and array.\nWhen a volume is moved, the specified protection groups must be in the target pod or array.\nEnter multiple ids in comma-separated format.\n" }, { "name": "add_to_protection_group_names", "value": "", "type": "query", "description": "The volumes will be added to the specified protection groups along with creation or movement\nacross pods and array.\nWhen a volume is moved, the specified protection groups must be in the target pod or array.\nEnter multiple names in a comma-separated format.\n" }, { "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": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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": "remove_from_protection_group_ids", "value": "", "type": "query", "description": "The volumes will be removed from the specified protection groups in the source pod or array along\nwith the move.\nThis can only be used when moving volumes across pods and arrays and must include all protection\ngroups that the volumes are members of before the move.\nEnter multiple ids in a comma-separated format.\n" }, { "name": "remove_from_protection_group_names", "value": "", "type": "query", "description": "The volumes will be removed from the specified protection groups in the source pod or array along\nwith the move.\nThis can only be used when moving volumes across pods and arrays and must include all protection\ngroups that the volumes are members of before the move.\nEnter multiple names in a comma-separated format.\n" }, { "name": "truncate", "value": "", "type": "query", "description": "If set to `true`, reduces the size of a volume\nduring a volume resize operation.\nWhen a volume is truncated, Purity automatically takes an undo snapshot,\nproviding a 24-hour window during which the previous contents\ncan be retrieved. After truncating a volume,\nits provisioned size can be subsequently increased,\nbut the data in truncated sectors cannot be retrieved.\nIf set to `false` or not set at all and the volume is being reduced in size,\nthe volume copy operation fails.\nRequired if the `provisioned` parameter is set to a volume size\nthat is smaller than the original size.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a volume by renaming, destroying, or resizing it.\nTo rename a volume, set `name` to the new name. To destroy a volume, set `destroyed=true`.\nTo recover a volume that has been destroyed and is pending eradication, set `destroyed=false`.\nSet the bandwidth and IOPS limits of a volume through the respective `bandwidth_limit` and\n`iops_limit` parameter. This moves the volume into a pod or volume group through the respective\n`pod` or `volume_group` parameter.\nThe `ids` or `names` parameter is" }, { "info": { "name": "Pure Storage Delete a Volume", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/volumes", "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": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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" } ] }, "docs": "Deletes a volume that has been destroyed and is pending eradication.\nEradicated volumes cannot be recovered.\nVolumes are destroyed using the `PATCH` method.\nThe `ids` or `names` parameter is required, but they cannot be set together.\n\n" }, { "info": { "name": "Pure Storage Create or Copy Volumes and Upsert Tags", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/volumes/batch", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_throttle", "value": "", "type": "query", "description": "If set to `true`, allows operation to fail if array health is not optimal.\n" }, { "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": "overwrite", "value": "", "type": "query", "description": "If set to `true`,\noverwrites an existing object during an object copy operation.\nIf set to `false` or not set at all and the target name is an existing object,\nthe copy operation fails.\nRequired if the `source` body parameter is set\nand the source overwrites an existing object during the copy operation.\n" }, { "name": "with_default_protection", "value": "", "type": "query", "description": "If specified as `true`, the initial protection of the newly created volumes will be\nthe union of the container default protection configuration and\n`add_to_protection_group_names`.\nIf specified as `false`, the default protection of the container will not be applied\nautomatically. The initial protection of the newly created volumes will be configured\nby `add_to_protection_group_names`.\nIf not specified, defaults to `true`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or copies a list of virtual storage volumes. Volumes of different\nsizes, vgroups, and tag upsertions can be copied this way.\n" }, { "info": { "name": "Pure Storage List Volume Diffs", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/volumes/diff", "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": "base_id", "value": "", "type": "query", "description": "ID of the volume or volume snapshot that the diff comparison is based on.\nIf a base volume or volume snapshot is not specified,\nall mapped blocks for the volume or volume snapshot are displayed.\nThe `base_name` or `base_id` parameter is required, but they cannot be set together.\n" }, { "name": "base_name", "value": "", "type": "query", "description": "Name of the volume or volume snapshot that the diff comparison is based on.\nIf a base volume or volume snapshot is not specified,\nall mapped blocks for the volume or volume snapshot are displayed.\nThe `base_name` or `base_id` parameter is required, but they cannot be set together.\n" }, { "name": "block_size", "value": "", "type": "query", "description": "Granularity at which to compare, in bytes. Must be a multiple of 512.\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": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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": "next_allocated_block_hint", "value": "", "type": "query", "description": "If set to `true`, appends offset of the next allocated block in bytes\nfor the volume specified in `names` or `ids` to the output `items`.\n`base_name` or `base_id` must not be specified if this is set to `true`.\nIf not specified, defaults to `false`.\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": "segment_length", "value": "", "type": "query", "description": "Length of the segment, in bytes, to compare.\n" }, { "name": "segment_offset", "value": "", "type": "query", "description": "Absolute offset, in bytes, of the segment to compare.\nMust be a multiple of block_size.\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 block differences for the specified volumes." }, { "info": { "name": "Pure Storage Create an Attempt to Copy Volumes and Upsert Tags", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/volumes/batch/test", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_throttle", "value": "", "type": "query", "description": "If set to `true`, allows operation to fail if array health is not optimal.\n" }, { "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": "overwrite", "value": "", "type": "query", "description": "If set to `true`,\noverwrites an existing object during an object copy operation.\nIf set to `false` or not set at all and the target name is an existing object,\nthe copy operation fails.\nRequired if the `source` body parameter is set\nand the source overwrites an existing object during the copy operation.\n" }, { "name": "with_default_protection", "value": "", "type": "query", "description": "If specified as `true`, the initial protection of the newly created volumes will be\nthe union of the container default protection configuration and\n`add_to_protection_group_names`.\nIf specified as `false`, the default protection of the container will not be applied\nautomatically. The initial protection of the newly created volumes will be configured\nby `add_to_protection_group_names`.\nIf not specified, defaults to `true`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an attempt to copy virtual storage volumes of different sizes in different vgroups and\nalso upserts tags, without actually creating them, to test if they can be successfully created.\nOnly available for creating volumes via a copy, not direct volume creation.\n\n" }, { "info": { "name": "Pure Storage List Volume Performance Data", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/volumes/performance", "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": "destroyed", "value": "", "type": "query", "description": "If set to `true`, lists only destroyed objects that are in the eradication pending state.\nIf set to `false`, lists only objects that are not destroyed.\nIf not set, lists both objects that are destroyed and those that are not destroyed.\n\nFor destroyed objects, the time remaining is displayed in milliseconds.\n\nIf object name(s) or id(s) are specified, then each object referenced must exist.\nIf `destroyed` is set to `true`, then each object referenced must also be destroyed.\nIf `destroyed` is set to `false`, then each object referenced must also not be destroyed.\nAn error is returned if any of these conditions are not met.\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": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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 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" }, { "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": "Displays real-time and historical performance data, real-time latency data, and average I/O\nsizes for each volume and and as a total of all volumes across the entire array.\n\n" }, { "info": { "name": "Pure Storage List Volume Performance Data by Array", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/volumes/performance/by-array", "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": "destroyed", "value": "", "type": "query", "description": "If set to `true`, lists only destroyed objects that are in the eradication pending state.\nIf set to `false`, lists only objects that are not destroyed.\nIf not set, lists both objects that are destroyed and those that are not destroyed.\n\nFor destroyed objects, the time remaining is displayed in milliseconds.\n\nIf object name(s) or id(s) are specified, then each object referenced must exist.\nIf `destroyed` is set to `true`, then each object referenced must also be destroyed.\nIf `destroyed` is set to `false`, then each object referenced must also not be destroyed.\nAn error is returned if any of these conditions are not met.\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": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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 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" }, { "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": "Displays real-time and historical performance data, real-time latency data,\nand average I/O size data.\nThe data returned is for each volume on the current array and for each volume\non any remote arrays that are visible to the current array.\nThe data is grouped by individual volumes\nand as a total across all volumes on each array.\n\n" }, { "info": { "name": "Pure Storage List Volumes That Are Members of Protection Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/volumes/protection-groups", "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": "group_ids", "value": "", "type": "query", "description": "A comma-separated list of group IDs.\n" }, { "name": "group_names", "value": "", "type": "query", "description": "Performs the operation on the unique group name specified.\nExamples of groups include host groups, pods, protection groups, and volume groups.\nEnter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.\n\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": "member_destroyed", "value": "", "type": "query", "description": "If true, returns only destroyed member objects. Returns an error if\na name of a live member object is specified in the member_names query param.\nIf false, returns only live member objects. Returns an error if\na name of a destroyed member object is specified in the member_names\nquery param.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique member IDs specified.\nEnter multiple member IDs in comma-separated format.\nThe `member_ids` or `member_names` parameter is required, but they cannot be set together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\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 volume members that belong to one or more protection groups.\n" }, { "info": { "name": "Pure Storage Create a Volume and Add it to a Protection Group", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/volumes/protection-groups", "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": "group_ids", "value": "", "type": "query", "description": "A comma-separated list of group IDs.\n" }, { "name": "group_names", "value": "", "type": "query", "description": "Performs the operation on the unique group name specified.\nExamples of groups include host groups, pods, protection groups, and volume groups.\nEnter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.\n\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique member IDs specified.\nEnter multiple member IDs in comma-separated format.\nThe `member_ids` or `member_names` parameter is required, but they cannot be set together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\n" } ] }, "docs": "Creates a volume member and adds it to a protection group.\nMembers that are already in the protection group are not affected.\nFor asynchronous replication, only members of the same type can belong to a protection group.\nThe `group_names` parameter represents the name of the protection group, and\nthe `member_names` and `member_ids` parameters represent the names or IDs of the volume.\nThe `group_names` and only one of `member_names` or `member_ids`\nparameters are required and must be set together." }, { "info": { "name": "Pure Storage Delete a Volume from a Protection Group", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/volumes/protection-groups", "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": "group_ids", "value": "", "type": "query", "description": "A comma-separated list of group IDs.\n" }, { "name": "group_names", "value": "", "type": "query", "description": "Performs the operation on the unique group name specified.\nExamples of groups include host groups, pods, protection groups, and volume groups.\nEnter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.\n\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique member IDs specified.\nEnter multiple member IDs in comma-separated format.\nThe `member_ids` or `member_names` parameter is required, but they cannot be set together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\n" } ] }, "docs": "Deletes a volume member from a protection group.\nAfter the member has been deleted, it is no longer protected by the group.\nAny protection group snapshots that were taken before the member was deleted\nare not affected.\nDeleting a member from a protection group does not delete the member from the array or realm,\nand the member can be added back to the protection group at any time.\nThe `group_names` parameter represents the name of the protection group, and\nthe `member_names` and `member_ids` para" }, { "info": { "name": "Pure Storage List Volume QoS Config", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/volumes/qos", "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": "destroyed", "value": "", "type": "query", "description": "If set to `true`, lists only destroyed objects that are in the eradication pending state.\nIf set to `false`, lists only objects that are not destroyed.\nIf not set, lists both objects that are destroyed and those that are not destroyed.\n\nFor destroyed objects, the time remaining is displayed in milliseconds.\n\nIf object name(s) or id(s) are specified, then each object referenced must exist.\nIf `destroyed` is set to `true`, then each object referenced must also be destroyed.\nIf `destroyed` is set to `false`, then each object referenced must also not be destroyed.\nAn error is returned if any of these conditions are not met.\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": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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 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 QoS configuration data for each volume.\n" }, { "info": { "name": "Pure Storage List Volume Space Information", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/volumes/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": "destroyed", "value": "", "type": "query", "description": "If set to `true`, lists only destroyed objects that are in the eradication pending state.\nIf set to `false`, lists only objects that are not destroyed.\nIf not set, lists both objects that are destroyed and those that are not destroyed.\n\nFor destroyed objects, the time remaining is displayed in milliseconds.\n\nIf object name(s) or id(s) are specified, then each object referenced must exist.\nIf `destroyed` is set to `true`, then each object referenced must also be destroyed.\nIf `destroyed` is set to `false`, then each object referenced must also not be destroyed.\nAn error is returned if any of these conditions are not met.\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": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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 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" }, { "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": "Displays the provisioned size and physical storage consumption data for each volume.\n\n" }, { "info": { "name": "Pure Storage List Tags", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/volumes/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": "resource_destroyed", "value": "", "type": "query", "description": "If set to `true`, returns only objects from destroyed resources. Returns an error if\nthe name of a live resource is specified in the `resource_names` query parameter.\nIf set to `false`, returns only objects from live resources. Returns an error if the\nname of a destroyed resource is specified in the `resource_names` query parameter.\n" }, { "name": "resource_ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nThe `resource_ids` or `resource_names` parameter is required, but they cannot be set together.\n" }, { "name": "resource_names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nThe `resource_ids` or `resource_names` parameter is required, but they cannot be set together.\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." }, { "info": { "name": "Pure Storage Delete Tags", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/volumes/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. Only one namespace is allowed per delete request.\n" }, { "name": "resource_ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nThe `resource_ids` or `resource_names` parameter is required, but they cannot be set together.\n" }, { "name": "resource_names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nThe `resource_ids` or `resource_names` parameter is required, but they cannot be set together.\n" } ] }, "docs": "Deletes specified tags." }, { "info": { "name": "Pure Storage Update Tags", "type": "http" }, "http": { "method": "PUT", "url": "/api/2.52/volumes/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" }, { "name": "resource_ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nThe `resource_ids` or `resource_names` parameter is required, but they cannot be set together.\n" }, { "name": "resource_names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\nThe `resource_ids` or `resource_names` parameter is required, but they cannot be set together.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates tags.\n" }, { "info": { "name": "Pure Storage Create a Dry Run Attempt to Copy a Volume", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/volumes/test", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "add_to_protection_group_ids", "value": "", "type": "query", "description": "The volumes will be added to the specified protection groups along with creation or movement\nacross pods and array.\nWhen a volume is moved, the specified protection groups must be in the target pod or array.\nEnter multiple ids in comma-separated format.\n" }, { "name": "add_to_protection_group_names", "value": "", "type": "query", "description": "The volumes will be added to the specified protection groups along with creation or movement\nacross pods and array.\nWhen a volume is moved, the specified protection groups must be in the target pod or array.\nEnter multiple names in a comma-separated format.\n" }, { "name": "allow_throttle", "value": "", "type": "query", "description": "If set to `true`, allows operation to fail if array health is not optimal.\n" }, { "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": "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": "overwrite", "value": "", "type": "query", "description": "If set to `true`,\noverwrites an existing object during an object copy operation.\nIf set to `false` or not set at all and the target name is an existing object,\nthe copy operation fails.\nRequired if the `source` body parameter is set\nand the source overwrites an existing object during the copy operation.\n" }, { "name": "with_default_protection", "value": "", "type": "query", "description": "If specified as `true`, the initial protection of the newly created volumes will be\nthe union of the container default protection configuration and\n`add_to_protection_group_names`.\nIf specified as `false`, the default protection of the container will not be applied\nautomatically. The initial protection of the newly created volumes will be configured\nby `add_to_protection_group_names`.\nIf not specified, defaults to `true`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a dry run attempt to see if copying a volume would\nsucceed. No virtual volumes are actually copied or created in this process.\n" }, { "info": { "name": "Pure Storage List Volumes That Are in Volume Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/volumes/volume-groups", "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": "group_ids", "value": "", "type": "query", "description": "A comma-separated list of group IDs.\n" }, { "name": "group_names", "value": "", "type": "query", "description": "Performs the operation on the unique group name specified.\nExamples of groups include host groups, pods, protection groups, and volume groups.\nEnter multiple names in comma-separated format. For example, `hgroup01,hgroup02`.\n\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": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique member IDs specified.\nEnter multiple member IDs in comma-separated format.\nThe `member_ids` or `member_names` parameter is required, but they cannot be set together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\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 volumes that are in a volume group.\n\n" }, { "info": { "name": "Pure Storage Get Volumes", "type": "http" }, "http": { "method": "GET", "url": "/api/1.5/volumes", "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": "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 volume objects.\n" } ] } ], "bundled": true }