{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Protection Groups API", "version": "2.52" }, "items": [ { "info": { "name": "Protection Groups", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Protection Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/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": "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 protection groups,\nincluding their associated source arrays or pods, replication targets,\nhosts, host groups, and volumes.\nThe list includes protection groups that were created on the\nlocal array or realm to replicate snapshot data to other arrays, pods or\noffload targets, created on a remote array or pod and replicated\nasynchronously to this array or realm, or created inside a pod\non a remote array or realm and stretched to the local array or realm.\n" }, { "info": { "name": "Pure Storage Create a Protection Group and Upsert Tags", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/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": "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": "source_ids", "value": "", "type": "query", "description": "The id of the protection group or protection group snapshot to be copied\ninto a new or existing protection group. If the destination protection group\nand all of its volumes already exist, include the `overwrite` parameter to\noverwrite all of the existing volumes with the snapshot contents.\nIf including the `overwrite` parameter, the names of the volumes that are\nbeing overwritten must match the names of the volumes that are being restored.\nIf the source is a protection group, the latest snapshot of the protection group\nwill be used as the source during the copy operation.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "The name of the protection group or protection group snapshot to be copied\ninto a new or existing protection group. If the destination protection group\nand all of its volumes already exist, include the `overwrite` parameter to\noverwrite all of the existing volumes with the snapshot contents.\nIf including the `overwrite` parameter, the names of the volumes that are\nbeing overwritten must match the names of the volumes that are being restored.\nIf the source is a protection group, the latest snapshot of the protection group\nwill be used as the source during the copy operation.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a protection group on the local array or realm for asynchronous replication.\n" }, { "info": { "name": "Pure Storage Modify a Protection Group", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/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": "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the protection group schedules to generate and replicate\nsnapshots to another array, pod or to an external storage system.\nRenames or destroys a protection group.\n" }, { "info": { "name": "Pure Storage Delete a Protection Group", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/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": "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 protection group that has been destroyed and is pending eradication.\nEradicated protection groups cannot be recovered.\nProtection groups are destroyed through the `PATCH` method.\nThe `names` parameter is required.\n" }, { "info": { "name": "Pure Storage List Protection Groups with Host Members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/protection-groups/hosts", "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_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 protection groups that have host members." }, { "info": { "name": "Pure Storage Create an Action to Add a Host to a Protection Group", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/protection-groups/hosts", "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_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 an action to add a host member 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` parameter represents the name of the host.\nThe `group_names` and `member_names` parameters are required and must be set together.\n\n" }, { "info": { "name": "Pure Storage Delete a Host from a Protection Group", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/protection-groups/hosts", "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_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 host member from a protection group.\nAfter the member has been removed, it is no longer protected by the group.\nAny protection group snapshots that were taken before the member was removed\nwill not be affected.\nRemoving 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` parameter represent" }, { "info": { "name": "Pure Storage List Protection Groups with Host Group Members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/protection-groups/host-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_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 protection groups that have host group members." }, { "info": { "name": "Pure Storage Creates an Action to Add a Host Group to a Protection Group", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/protection-groups/host-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_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 an action to add a host group member 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` parameter represents the name of the host group.\nThe `group_names` and `member_names` parameters are required and must be set together.\n" }, { "info": { "name": "Pure Storage Delete a Host Group from a Protection Group", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/protection-groups/host-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_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 host group member from a protection group.\nAfter the member has been removed, it is no longer protected by the group.\nProtection group snapshots taken before the member was removed will not be affected.\nRemoving a member from a protection group does not delete the member from the array\nor realm, and 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` parameter represents the na" }, { "info": { "name": "Pure Storage List Protection Group Replication Performance Data", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/protection-groups/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" } ] }, "docs": "Displays the total number of bytes of replication data transmitted and received per second.\nThe data is grouped by protection group.\n\n" }, { "info": { "name": "Pure Storage List Protection Group Replication Performance Data with Array Details", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/protection-groups/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" } ] }, "docs": "Displays the total number of bytes of replication data transmitted and received per second.\nThe data is grouped by protection group and includes the names of the source array and targets\nfor each protection group.\n" }, { "info": { "name": "Pure Storage List Protection Group Space Information", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/protection-groups/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": "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 provisioned size and physical storage consumption data for each protection group.\n\n" }, { "info": { "name": "Pure Storage List Tags", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/protection-groups/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/protection-groups/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/protection-groups/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 List Protection Groups with Targets", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/protection-groups/targets", "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 protection groups that have target arrays, pods, or offload targets.\n\n\n" }, { "info": { "name": "Pure Storage Create an Action to Add a Target to a Protection Group", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/protection-groups/targets", "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 an action to add an array, pod, or offload target to a protection group.\nThe `group_names` parameter represents the name of the protection group.\nThe `member_names` parameter represents the name of the array, pod, or offload target\nthat is being added to the protection group.\nThe `group_names` and `member_names` parameters are required and must be set together.\n\n" }, { "info": { "name": "Pure Storage Modify a Protection Group Target", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/protection-groups/targets", "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies the source array or pod to replicate protection group data to the target,\nor disallows the source array or pod from replicating protection group data to the target.\nThe `allowed` parameter must be set from the target array or realm.\nThe `group_names` parameter represents the name of the protection group.\nThe `allowed` and `group_names` parameters are required and must be set together.\nOffload targets do not support the `allowed` parameter.\n\n" }, { "info": { "name": "Pure Storage Delete a Target from a Protection Group", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/protection-groups/targets", "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 an array, pod, or offload target from a protection group.\nThe `group_names` parameter represents the name of the protection group.\nThe `member_names` parameter represents the name of the array, pod, or offload target\nthat is being removed from the protection group.\nThe `group_names` and `member_names` parameters are required and must be set together.\n\n" }, { "info": { "name": "Pure Storage List Protection Groups with Volume Members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/protection-groups/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": "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": "Performs the operation on the unique group id specified.\nProvide multiple resource IDs in comma-separated format.\nThe group_ids or names parameter is required, but they cannot be set together.\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": "include_remote", "value": "", "type": "query", "description": "If set to `true` the response will include remote membership for protection groups that belong\nto the remote arrays or realms as well as local volumes.\nDefaults to `false`.\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 protection groups that have volume members.\n" }, { "info": { "name": "Pure Storage Create a Volume to Add it to a Protection Group", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/protection-groups/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": "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` parameter, and either the `member_names` or `member_ids`\nparameters are required and must be set" }, { "info": { "name": "Pure Storage Delete a Volume from a Protection Group", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/protection-groups/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": "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 are 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" } ] } ], "bundled": true }