{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Bucket Replica Links API", "version": "2.52" }, "items": [ { "info": { "name": "Bucket Replica Links", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage GET Bucket-replica-links", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/bucket-replica-links", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "allow_errors", "value": "", "type": "query", "description": "If set to `true`, the API will allow the operation to continue even if there are errors.\nAny errors will be returned in the `errors` field of the response.\nIf set to `false`, the operation will fail if there are any errors.\n" }, { "name": "context_names", "value": "", "type": "query", "description": "Performs the operation on the unique contexts specified.\n\nIf specified, each context name must be the name of an array in the same fleet or\nthe name of the fleet itself.\n\nIf not specified, the context will default to the array that received this request.\n\nOther parameters provided with the request, such as names of volumes or snapshots,\nare resolved relative to the provided `context`.\n\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\n" }, { "name": "continuation_token", "value": "", "type": "query", "description": "A token used to retrieve the next page of data\nwith some consistency guaranteed.\nThe token is a Base64 encoded value.\nSet `continuation_token` to the system-generated token taken from the `x-next-token`\nheader field of the response.\nA query has reached its last page when the response does not include a token.\nPagination requires the `limit` and `continuation_token`\nquery parameters.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `ids`, then an error is returned.\nThis cannot be provided together with the `name` or `names` query parameters.\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": "local_bucket_ids", "value": "", "type": "query", "description": "A comma-separated list of local bucket IDs. If after filtering, there is\nnot at least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with the `local_bucket_names`\nquery parameter.\n" }, { "name": "local_bucket_names", "value": "", "type": "query", "description": "A comma-separated list of local bucket names. If there is not at least one\nresource that matches each of the elements, then an error is returned. This\ncannot be provided together with `local_bucket_ids` query parameter.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "remote_bucket_names", "value": "", "type": "query", "description": "A comma-separated list of remote bucket names. If there is not at least one\nresource that matches each of the elements, then an error is returned.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "A comma-separated list of remote array IDs. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_names` query parameter.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "A comma-separated list of remote array names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_ids` query parameter.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" }, { "name": "total_only", "value": "", "type": "query", "description": "If set to `true`, returns the aggregate value of all items after filtering.\nWhere it makes more sense, the average value is displayed instead.\nThe values are displayed for each name where meaningful.\nIf `total_only=true`, the `items` list will be empty.\n" } ] }, "docs": "List bucket replica links for object replication." }, { "info": { "name": "Pure Storage POST Bucket-replica-links", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/bucket-replica-links", "headers": [ { "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": "local_bucket_ids", "value": "", "type": "query", "description": "A comma-separated list of local bucket IDs. If after filtering, there is\nnot at least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with the `local_bucket_names`\nquery parameter.\n" }, { "name": "local_bucket_names", "value": "", "type": "query", "description": "A comma-separated list of local bucket names. If there is not at least one\nresource that matches each of the elements, then an error is returned. This\ncannot be provided together with `local_bucket_ids` query parameter.\n" }, { "name": "remote_bucket_names", "value": "", "type": "query", "description": "A comma-separated list of remote bucket names. If there is not at least one\nresource that matches each of the elements, then an error is returned.\n" }, { "name": "remote_credentials_ids", "value": "", "type": "query", "description": "A comma-separated list of remote credentials IDs. If after filtering, there\nis not at least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with the\n`remote_credentials_names` query parameter.\n" }, { "name": "remote_credentials_names", "value": "", "type": "query", "description": "A comma-separated list of remote credentials names. If there is not at least\none resource that matches each of the elements, then an error is returned.\nThis cannot be provided together with the `remote_credentials_ids` query\nparameter.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a bucket replica link for object replication." }, { "info": { "name": "Pure Storage PATCH Bucket-replica-links", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/bucket-replica-links", "headers": [ { "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 resource IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `ids`, then an error is returned.\nThis cannot be provided together with the `name` or `names` query parameters.\n" }, { "name": "local_bucket_ids", "value": "", "type": "query", "description": "A comma-separated list of local bucket IDs. If after filtering, there is\nnot at least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with the `local_bucket_names`\nquery parameter.\n" }, { "name": "local_bucket_names", "value": "", "type": "query", "description": "A comma-separated list of local bucket names. If there is not at least one\nresource that matches each of the elements, then an error is returned. This\ncannot be provided together with `local_bucket_ids` query parameter.\n" }, { "name": "remote_bucket_names", "value": "", "type": "query", "description": "A comma-separated list of remote bucket names. If there is not at least one\nresource that matches each of the elements, then an error is returned.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "A comma-separated list of remote array IDs. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_names` query parameter.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "A comma-separated list of remote array names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_ids` query parameter.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the configuration of a bucket replica link including whether the link is paused and the object store remote credentials used." }, { "info": { "name": "Pure Storage DELETE Bucket-replica-links", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/bucket-replica-links", "headers": [ { "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 resource IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `ids`, then an error is returned.\nThis cannot be provided together with the `name` or `names` query parameters.\n" }, { "name": "local_bucket_ids", "value": "", "type": "query", "description": "A comma-separated list of local bucket IDs. If after filtering, there is\nnot at least one resource that matches each of the elements, then an error\nis returned. This cannot be provided together with the `local_bucket_names`\nquery parameter.\n" }, { "name": "local_bucket_names", "value": "", "type": "query", "description": "A comma-separated list of local bucket names. If there is not at least one\nresource that matches each of the elements, then an error is returned. This\ncannot be provided together with `local_bucket_ids` query parameter.\n" }, { "name": "remote_bucket_names", "value": "", "type": "query", "description": "A comma-separated list of remote bucket names. If there is not at least one\nresource that matches each of the elements, then an error is returned.\n" }, { "name": "remote_ids", "value": "", "type": "query", "description": "A comma-separated list of remote array IDs. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_names` query parameter.\n" }, { "name": "remote_names", "value": "", "type": "query", "description": "A comma-separated list of remote array names. If, after filtering, there is not at least one\nresource that matches each of the elements, then an error is returned. This cannot be provided\ntogether with the `remote_ids` query parameter.\n" } ] }, "docs": "Delete a bucket replica link." }, { "info": { "name": "Pure Storage Get Bucket Replica Links", "type": "http" }, "http": { "method": "GET", "url": "/api/1.5/bucket-replica-links", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "continuation_token", "value": "", "type": "query", "description": "An opaque token used to iterate over a collection.\nThe token to use on the next request is returned in the\n`continuation_token` field of the result.\nSingle quotes are required around all strings.\n" }, { "name": "filter", "value": "", "type": "query", "description": "Exclude resources that don't match the specified criteria.\nSingle quotes are required around all strings inside the filters.\n" }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of resource IDs.\nIf there is not at least one resource that matches each `id` element,\nan error is returned.\nSingle quotes are required around all strings.\n" }, { "name": "limit", "value": "", "type": "query", "description": "Limit the size of the response to the specified number of resources.\nA limit of 0 can be used to get the number of resources without getting\nall of the resources. It will be returned in the total_item_count field.\nIf a client asks for a page size larger than the maximum number, the request\nis still valid. In that case the server just returns the maximum number of\nitems, disregarding the client's page size request. If not specified, defaults\nto 1000.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A list of member IDs. Member IDs separated by a `+` indicate that both\nmembers must be present in each element. Member IDs separated by a `,`\nindicate that at least one member must be present in each element.\nIf there is not at least one resource that matches each `member_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of member IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A list of member names. Member names separated by a `+` indicate that both\nmembers must be present in each element. Member names separated by a `,`\nindicate that at least one member must be present in each element.\nIf there is not at least one resource that matches each `member_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of member names separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "offset", "value": "", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort the response by the specified fields (in descending order if '-'\nis appended to the field name).\nIf you provide a sort you will not get a continuation token in\nthe response.\n" }, { "name": "source_ids", "value": "", "type": "query", "description": "A list of source IDs. Source IDs separated by a `+` indicate that both\nsources must be present in each element. Source IDs separated by a `,`\nindicate that at least one source must be present in each element.\nIf there is not at least one resource that matches each `source_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of source IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "source_names", "value": "", "type": "query", "description": "A list of source names. Source names separated by a `+` indicate that both\nsources must be present in each element. Source names separated by a `,`\nindicate that at least one source must be present in each element.\nIf there is not at least one resource that matches each `source_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of source names separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "target_ids", "value": "", "type": "query", "description": "A list of target IDs. Target IDs separated by a `+` indicate that both\ntargets must be present in each element. Target IDs separated by a `,`\nindicate that at least one target must be present in each element.\nIf there is not at least one resource that matches each `target_id` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of target IDs separated by a `+`\nmust be entered in the same item cell.\n" }, { "name": "target_names", "value": "", "type": "query", "description": "A list of target names. Target names separated by a `+` indicate that both\ntargets must be present in each element. Target names separated by a `,`\nindicate that at least one target must be present in each element.\nIf there is not at least one resource that matches each `target_name` element,\nan error is returned.\nSingle quotes are required around all strings.\nWhen using Try it Out in Swagger, a list of target names separated by a `+`\nmust be entered in the same item cell.\n" } ] }, "docs": "Retrieves information about bucket replica links.\n" } ] } ], "bundled": true }