{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Remote Protection Group Snapshots API", "version": "2.52" }, "items": [ { "info": { "name": "Remote Protection Group Snapshots", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Remote Protection Group Snapshots", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/remote-protection-group-snapshots", "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": "on", "value": "", "type": "query", "description": "Performs the operation on the target name specified.\nEnter multiple target names in comma-separated format.\nFor example, `targetName01,targetName02`.\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": "source_ids", "value": "", "type": "query", "description": "Performs the operation on the source ID specified.\nEnter multiple source IDs in comma-separated format.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "Performs the operation on the source name specified.\nEnter multiple source names in comma-separated format. For example, `name01,name02`.\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 remote protection group snapshots.\n" }, { "info": { "name": "Pure Storage Create Remote Protection Group Snapshot and Tags", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/remote-protection-group-snapshots", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_throttle", "value": "", "type": "query", "description": "If set to `true`, allows snapshot to fail if array health is not optimal.\n" }, { "name": "apply_retention", "value": "", "type": "query", "description": "If `true`, applies the local and remote retention policy to the snapshots.\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": "convert_source_to_baseline", "value": "", "type": "query", "description": "Set to `true` to have the snapshot be eradicated when it is no longer baseline on source.\n" }, { "name": "for_replication", "value": "", "type": "query", "description": "If `true`, destroys and eradicates the snapshot after 1 hour.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n\nIf there is not at least one resource that matches\neach of the elements of `names`, then an error is returned,\nexcept when creating new resources.\n" }, { "name": "on", "value": "", "type": "query", "description": "Performs the operation on the target name specified.\nFor example, `targetName01`.\n" }, { "name": "replicate", "value": "", "type": "query", "description": "If set to `true`, queues up and begins replicating to each allowed target after all\nearlier replication sessions for the same protection group have been\ncompleted to that target. The `replicate` and `replicate_now` parameters cannot be used together.\n" }, { "name": "replicate_now", "value": "", "type": "query", "description": "If set to `true`, replicates the snapshots to each allowed target.\nThe `replicate` and `replicate_now` parameters cannot be used together.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "Performs the operation on the source ID specified.\nEnter multiple source IDs in comma-separated format.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "Performs the operation on the source name specified.\nEnter multiple source names in comma-separated format. For example, `name01,name02`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates remote protection group snapshots.\n" }, { "info": { "name": "Pure Storage Modify a Remote Protection Group Snapshot", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/remote-protection-group-snapshots", "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" }, { "name": "on", "value": "", "type": "query", "description": "Performs the operation on the target name specified.\nFor example, `targetName01`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a remote protection group snapshot, removing it from the offload target and\ndestroying the snapshot.\nThe `on` parameter represents the name of the offload target.\nThe `ids` or `names` parameter and the `on` parameter are required and must be used together.\n" }, { "info": { "name": "Pure Storage Delete a Remote Protection Group Snapshot", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/remote-protection-group-snapshots", "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" }, { "name": "on", "value": "", "type": "query", "description": "Performs the operation on the target name specified.\nFor example, `targetName01`.\n" } ] }, "docs": "Deletes a remote protection group snapshot that has been destroyed and is pending eradication.\nEradicated remote protection group snapshots cannot be recovered.\nRemote protection group snapshots are destroyed using the `PATCH` method.\nThe `names` parameter represents the name of the protection group snapshot.\nThe `on` parameter represents the name of the offload target.\nThe `names` and `on` parameters are required and must be used together.\n" }, { "info": { "name": "Pure Storage List Remote Protection Groups with Transfer Statistics", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/remote-protection-group-snapshots/transfer", "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": "on", "value": "", "type": "query", "description": "Performs the operation on the target name specified.\nEnter multiple target names in comma-separated format.\nFor example, `targetName01,targetName02`.\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": "source_ids", "value": "", "type": "query", "description": "Performs the operation on the source ID specified.\nEnter multiple source IDs in comma-separated format.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "Performs the operation on the source name specified.\nEnter multiple source names in comma-separated format. For example, `name01,name02`.\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 remote protection groups and their transfer statistics.\n" }, { "info": { "name": "Pure Storage Create an Attempt to Take Remote Protection Group Snapshot", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/remote-protection-group-snapshots/test", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_throttle", "value": "", "type": "query", "description": "If set to `true`, allows snapshot to fail if array health is not optimal.\n" }, { "name": "apply_retention", "value": "", "type": "query", "description": "If `true`, applies the local and remote retention policy to the snapshots.\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": "convert_source_to_baseline", "value": "", "type": "query", "description": "Set to `true` to have the snapshot be eradicated when it is no longer baseline on source.\n" }, { "name": "for_replication", "value": "", "type": "query", "description": "If `true`, destroys and eradicates the snapshot after 1 hour.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n\nIf there is not at least one resource that matches\neach of the elements of `names`, then an error is returned,\nexcept when creating new resources.\n" }, { "name": "on", "value": "", "type": "query", "description": "Performs the operation on the target name specified.\nFor example, `targetName01`.\n" }, { "name": "replicate", "value": "", "type": "query", "description": "If set to `true`, queues up and begins replicating to each allowed target after all\nearlier replication sessions for the same protection group have been\ncompleted to that target. The `replicate` and `replicate_now` parameters cannot be used together.\n" }, { "name": "replicate_now", "value": "", "type": "query", "description": "If set to `true`, replicates the snapshots to each allowed target.\nThe `replicate` and `replicate_now` parameters cannot be used together.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "Performs the operation on the source ID specified.\nEnter multiple source IDs in comma-separated format.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "Performs the operation on the source name specified.\nEnter multiple source names in comma-separated format. For example, `name01,name02`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an attempt to take a remote protection group snapshot without\nactually taking it, to test if the snapshot can be successfully taken.\n" } ] } ], "bundled": true }