{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Legal Holds API", "version": "2.52" }, "items": [ { "info": { "name": "Legal Holds", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Legal Holds", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/legal-holds", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "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 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).\nNOTE: If you provide a sort you will not get a `continuation_token` in\nthe response.\n" } ] }, "docs": "List legal holds." }, { "info": { "name": "Pure Storage Create a Legal Hold", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/legal-holds", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a legal hold instance." }, { "info": { "name": "Pure Storage Update a Legal Hold", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/legal-holds", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "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": "Update a legal hold instance." }, { "info": { "name": "Pure Storage Delete a Legal Hold", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/legal-holds", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "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": "Delete a legal hold instance. Deletion is not allowed if the legal hold is applied to one or more paths." }, { "info": { "name": "Pure Storage List Held Entities", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/legal-holds/held-entities", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "file_system_ids", "value": "", "type": "query", "description": "A comma-separated list of file system IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `file_system_ids`, then an error is returned.\nThis cannot be provided together with the `file_system_names` query parameter.\n" }, { "name": "file_system_names", "value": "", "type": "query", "description": "A comma-separated list of file system names.\nIf there is not at least one resource that matches\neach of the elements of `file_system_names`, then an error is returned.\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": "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": "paths", "value": "", "type": "query", "description": "A comma-separated list of paths used for filtering file locks query by paths.\nThis may only be specified if `file_system_ids` or `file_system_names` is\nalso specified.\nThis cannot be provided together with the `inodes` query parameter.\n" } ] }, "docs": "List entities to which a legal hold has been applied." }, { "info": { "name": "Pure Storage Apply This Legal Hold to a New Entity", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/legal-holds/held-entities", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "file_system_ids", "value": "", "type": "query", "description": "A comma-separated list of file system IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `file_system_ids`, then an error is returned.\nThis cannot be provided together with the `file_system_names` query parameter.\n" }, { "name": "file_system_names", "value": "", "type": "query", "description": "A comma-separated list of file system names.\nIf there is not at least one resource that matches\neach of the elements of `file_system_names`, then an error is returned.\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": "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": "paths", "value": "", "type": "query", "description": "A comma-separated list of paths used for filtering file locks query by paths.\nThis may only be specified if `file_system_ids` or `file_system_names` is\nalso specified.\nThis cannot be provided together with the `inodes` query parameter.\n" }, { "name": "recursive", "value": "", "type": "query", "description": "This is a flag to set when recursively applying/releasing legal holds on entities.\nBy default, it is set to be false.\nThe `recursive` flag is required when applying/releasing a hold to/from a directory.\n" } ] }, "docs": "Apply this legal hold to a new entity.\nThe `names`, `file_system_names` and `paths` query parameters are required.\nThe `recursive` flag is required when applying a hold to a directory.\n" }, { "info": { "name": "Pure Storage Release This Legal Hold from the Given Entity", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/legal-holds/held-entities", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "file_system_ids", "value": "", "type": "query", "description": "A comma-separated list of file system IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `file_system_ids`, then an error is returned.\nThis cannot be provided together with the `file_system_names` query parameter.\n" }, { "name": "file_system_names", "value": "", "type": "query", "description": "A comma-separated list of file system names.\nIf there is not at least one resource that matches\neach of the elements of `file_system_names`, then an error is returned.\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": "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": "paths", "value": "", "type": "query", "description": "A comma-separated list of paths used for filtering file locks query by paths.\nThis may only be specified if `file_system_ids` or `file_system_names` is\nalso specified.\nThis cannot be provided together with the `inodes` query parameter.\n" }, { "name": "recursive", "value": "", "type": "query", "description": "This is a flag to set when recursively applying/releasing legal holds on entities.\nBy default, it is set to be false.\nThe `recursive` flag is required when applying/releasing a hold to/from a directory.\n" }, { "name": "released", "value": "", "type": "query", "description": "This is a flag to set when releasing an attached legal hold from a path.\n" } ] }, "docs": "Release this legal hold from the given entity.\nThe `names`, `file_system_names`, `paths` and `released` query parameters are required.\nThe `recursive` flag is required when releasing a hold from a directory.\n" } ] } ], "bundled": true }