{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Pods API", "version": "2.52" }, "items": [ { "info": { "name": "Pods", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Pods", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pods", "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 pods that are stretched to this array.\n" }, { "info": { "name": "Pure Storage Create a Pod", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/pods", "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": "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a pod on the local array.\nEach pod must be given a unique name across the arrays to which they are stretched.\nA pod cannot be stretched to an array that already contains a pod with the same name.\nAfter a pod has been created, add volumes and protection groups,\nand then stretch the pod to another connected array or realm.\n" }, { "info": { "name": "Pure Storage Modify a Pod", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/pods", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "abort_quiesce", "value": "", "type": "query", "description": "Set to `true` to promote the pod when the `pod-replica-link` is in the `quiescing` state and\nabort when waiting for the `pod-replica-link` to complete the quiescing operation.\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": "destroy_contents", "value": "", "type": "query", "description": "Set to `true` to destroy contents (e.g., volumes, protection groups, snapshots) and containers\n(e.g., realms, pods, volume groups), including eradicating containers with content.\n" }, { "name": "from_member_ids", "value": "", "type": "query", "description": "Move the resource from the specified local member realm or array.\nThis should be a union of all local realms and arrays from which the resource should be removed.\nEnter multiple IDs in a comma-separated format.\n" }, { "name": "from_member_names", "value": "", "type": "query", "description": "Move the resource from the specified local member realm or array.\nThis should be a union of all local realms and arrays to be removed from the specified resource.\nEnter multiple names in a comma-separated format.\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": "move_with_host_group_names", "value": "", "type": "query", "description": "The host groups to be moved together with the pods to the specified local member realm or array.\nAll the hosts in the host groups will also be moved.\nEnter multiple names in a comma-separated format.\n" }, { "name": "move_with_host_names", "value": "", "type": "query", "description": "The hosts to be moved together with the pods to the specified local member realm or array.\nEnter multiple names in a comma-separated format.\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": "promote_from", "value": "", "type": "query", "description": "The `undo-demote` pod that should be used to promote the pod.\nAfter the pod has been promoted, it will have the same data as the\n`undo-demote` pod and the `undo-demote` pod will be eradicated.\n" }, { "name": "quiesce", "value": "", "type": "query", "description": "Set to `true` to demote the pod after the `pod-replica-link` goes into `quiesced` state and allow\nthe pod to become a target of the remote pod.\nThis ensures that all local data has been replicated to the remote pod before the pod is demoted.\n" }, { "name": "skip_quiesce", "value": "", "type": "query", "description": "Set to `true` to demote the pod without quiescing the `pod-replica-link` and allow the pod to\nbecome a target of the remote pod.\nThis stops all pending replication to the remote pod.\n" }, { "name": "to_member_ids", "value": "", "type": "query", "description": "The resource will be moved to the specified local member realm or array.\nEnter multiple IDs in a comma-separated format.\n" }, { "name": "to_member_names", "value": "", "type": "query", "description": "The resource will be moved to the specified local member realm or array.\nEnter multiple names in a comma-separated format.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies pod details.\n" }, { "info": { "name": "Pure Storage Delete a Pod", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/pods", "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": "eradicate_contents", "value": "", "type": "query", "description": "Set to `true` to eradicate contents (e.g., volumes, protection groups, snapshots) and containers\n(e.g., realms, pods, volume groups). This enables you to eradicate containers with contents.\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 pod that has been destroyed and is pending eradication.\nEradicated pods cannot be recovered. Pods are destroyed using the PATCH method.\nThe `ids` or `names` parameter is required, but they cannot be set together.\n" }, { "info": { "name": "Pure Storage List Pods and Their the Array Members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pods/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": "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 pods and the local and remote arrays over which the pods are stretched.\nPods with realm members will not be returned.\nThe optional `group_names` parameter represents the name of the pod.\nThe optional `member_names` parameter\nrepresents the name of the array over which the pod is stretched.\n(Deprecated) Use pods/members instead.)\n" }, { "info": { "name": "Pure Storage Creates a Pod to Be Stretched to an Array", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/pods/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" }, { "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 pod to be stretched to an array.\nWhen a pod is stretched to an array,\nthe data in the arrays over which the pod is stretched is synchronously replicated.\nThe `group_names` parameter represents the name of the pod to be stretched.\nThe `member_names` parameter represents the name of the array over which the pod is\nto be stretched.\nThe `group_names` and `member_names` parameters are required and must be set together.\n(Deprecated) Use pods/members instead.\n" }, { "info": { "name": "Pure Storage Delete a Pod That Was Stretched to an Array", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/pods/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" }, { "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" }, { "name": "with_unknown", "value": "", "type": "query", "description": "If set to `true`, unstretches the specified pod from the specified array by force.\nUse the `with_unknown` parameter in the following rare event: the local array goes offline\nwhile the pod is still stretched across two arrays,\nthe status of the remote array becomes unknown,\nand there is no guarantee that the pod is online elsewhere.\n" } ] }, "docs": "Deletes a pod that was stretchd to an array, collapsing the pod to a single array.\nUnstretch a pod from an array when the volumes within the stretched pod\nno longer need to be synchronously replicated between the two arrays.\nAfter a pod has been unstretched, synchronous replication stops.\nA destroyed version of the pod with 'restretch' appended to the pod name\nis created on the array that no longer has the pod.\nThe restretched pod represents a point-in-time snapshot of the pod,\njust before it wa" }, { "info": { "name": "Pure Storage List Pods and Their Members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pods/members", "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": "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": "pod_ids", "value": "", "type": "query", "description": "A comma-separated list of pod IDs.\n" }, { "name": "pod_names", "value": "", "type": "query", "description": "Performs the operation on the unique pod name specified.\nEnter multiple names in comma-separated format. For example, `pod01,pod02`.\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 pods and the local and remote members over which the pods are stretched.\nCurrently either array or realm is supported as member.\n" }, { "info": { "name": "Pure Storage Creates a Pod to Be Stretched to a Member", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/pods/members", "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": "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": "pod_ids", "value": "", "type": "query", "description": "A comma-separated list of pod IDs.\n" }, { "name": "pod_names", "value": "", "type": "query", "description": "Performs the operation on the unique pod name specified.\nEnter multiple names in comma-separated format. For example, `pod01,pod02`.\n" } ] }, "docs": "Creates a pod to be stretched to a member.\nWhen a pod is stretched to an array or a realm on another array, the data in the arrays\nor realms over which the pod is stretched is synchronously replicated.\nThe `member_names` or `member_ids` parameter represents the array or realm over which\nthe pod is to be stretched.\nBoth pod and member must be specified by name or ID.\n" }, { "info": { "name": "Pure Storage Delete a Member from a Pod", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/pods/members", "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": "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": "pod_ids", "value": "", "type": "query", "description": "A comma-separated list of pod IDs.\n" }, { "name": "pod_names", "value": "", "type": "query", "description": "Performs the operation on the unique pod name specified.\nEnter multiple names in comma-separated format. For example, `pod01,pod02`.\n" }, { "name": "with_unknown", "value": "", "type": "query", "description": "If set to `true`, unstretches the specified pod from the specified array by force.\nUse the `with_unknown` parameter in the following rare event: the local array goes offline\nwhile the pod is still stretched across two arrays,\nthe status of the remote array becomes unknown,\nand there is no guarantee that the pod is online elsewhere.\n" } ] }, "docs": "Deletes a stretched pod from an array or realm, collapsing the pod to a member array\nor realm. Unstretch a pod from an array or realm when the volumes within the stretched\npodno longer need to be synchronously replicated between the two members.\nAfter a pod has been unstretched, synchronous replication stops.\nA destroyed version of the pod with 'restretch' appended to the pod name\nis created on the member that no longer has the pod.\nThe restretched pod represents a point-in-time snapshot of the " }, { "info": { "name": "Pure Storage List Pod Performance Data", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pods/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": "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" }, { "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 sizes across all pods, displayed both by pod and as a total across all pods.\n" }, { "info": { "name": "Pure Storage List Pod Performance Data by Array", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pods/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": "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" }, { "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 is displayed as a total across all pods on the local array and by individual pod.\n" }, { "info": { "name": "Pure Storage List Pod Replication Performance Data", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pods/performance/replication", "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`, only return the aggregate value of all items after filtering.\nFor real-time performance, the values are aggregated for the latest timestamp.\nFor historical performance, the values are aggregated for each timestamp from\n`start_time` to `end_time`. Where it makes more sense, the average value is\ndisplayed instead. The values are displayed for each name where meaningful.\nIf `total_only=true`, the `items` list will be empty.\n" } ] }, "docs": "Displays pod replication performance data.\nThe data returned is the real-time and historical performance data for each replication type\nat the pod level. Values include `continuous`, `periodic`, `resync`, and `sync`.\n\n" }, { "info": { "name": "Pure Storage List Pod Replication Performance Data by Array", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pods/performance/replication/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 pod replication performance data, organized by array.\nThe data returned is the real-time and historical performance data for each replication type\nat the pod level. Values include `continuous`, `periodic`, `resync`, and `sync`.\n\n" }, { "info": { "name": "Pure Storage List Pod Space Information", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pods/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 provisioned size and physical storage consumption data for each pod on the\nlocal array.\n" }, { "info": { "name": "Pure Storage List Tags", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/pods/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/pods/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/pods/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 for all specified objects." }, { "info": { "name": "Pure Storage Create an Attempt to Clone a Pod", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/pods/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": "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an attempt to clone a pod on the local array without actually cloning it\nto test whether the pod can be successfully cloned. This action does not suppport pod creation.\n" }, { "info": { "name": "Pure Storage Get Pods", "type": "http" }, "http": { "method": "GET", "url": "/api/1.5/pods", "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 pod objects.\n" } ] } ], "bundled": true }