{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Usage API", "version": "2.52" }, "items": [ { "info": { "name": "Usage", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage GET Usage/groups", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/usage/groups", "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": "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": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "gids", "value": "", "type": "query", "description": "A comma-separated list of group IDs.\nIf there is not at least one resource that matches\neach of the elements of `gids`, then an error is returned.\nThis cannot be provided together with `group_names` query parameter.\n" }, { "name": "group_names", "value": "", "type": "query", "description": "A comma-separated list of group names.\nIf there is not at least one resource that matches\neach of the elements of `group_names`, then an error is returned.\nThis cannot be provided together with `gids` query parameter.\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": "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 groups with hard limit quotas and their file system usage." }, { "info": { "name": "Pure Storage GET Usage/users", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/usage/users", "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": "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": "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": "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" }, { "name": "uids", "value": "", "type": "query", "description": "A comma-separated list of user IDs.\nIf there is not at least one resource that matches\neach of the elements of `uids`, then an error is returned.\nThis cannot be provided together with `user_names` query parameter.\n" }, { "name": "user_names", "value": "", "type": "query", "description": "A comma-separated list of user names.\nIf there is not at least one resource that matches\neach of the elements of `user_names`, then an error is returned.\nThis cannot be provided together with `uids` query parameter.\n" } ] }, "docs": "List users with hard limit quotas and their file system usage." } ] } ], "bundled": true }