{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Policies - User and Group Quota Policy API", "version": "2.52" }, "items": [ { "info": { "name": "Policies - User and Group Quota Policy", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage GET User-group-quota-policies", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/user-group-quota-policies", "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": "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": "Displays a list of quota policies for users and groups for file systems." }, { "info": { "name": "Pure Storage POST User-group-quota-policies", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/user-group-quota-policies", "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": "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": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user-group-quota policy for file systems. To import existing purequota and purefs configured quotas to a new policy, the file_system_names or file_system_ids parameter is required, but they cannot be set together. To create a policy from scratch, policy body is required." }, { "info": { "name": "Pure Storage PATCH User-group-quota-policies", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/user-group-quota-policies", "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": "ignore_usage", "value": "", "type": "query", "description": "Flag used to override checks for user-group-quota management operations.\nIf set to `true`, user/group usage is not checked against the `quota_limits` of\nuser-group-quota rules.\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": "versions", "value": "", "type": "query", "description": "A comma-separated list of versions. This is an optional query param used for concurrency control.\nThe ordering should match the names or ids query param.\nThis will fail with a 412 Precondition failed if the resource was changed and the current\nversion of the resource doesn't match the value in the query param.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies an existing user-group-quota policy's attributes." }, { "info": { "name": "Pure Storage DELETE User-group-quota-policies", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/user-group-quota-policies", "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": "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": "versions", "value": "", "type": "query", "description": "A comma-separated list of versions. This is an optional query param used for concurrency control.\nThe ordering should match the names or ids query param.\nThis will fail with a 412 Precondition failed if the resource was changed and the current\nversion of the resource doesn't match the value in the query param.\n" } ] }, "docs": "Deletes one or more user-group-quota policies." }, { "info": { "name": "Pure Storage GET User-group-quota-policies/rules", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/user-group-quota-policies/rules", "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": "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": "Displays a list of user-group-quota policy rules.\n" }, { "info": { "name": "Pure Storage POST User-group-quota-policies/rules", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/user-group-quota-policies/rules", "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": "ignore_usage", "value": "", "type": "query", "description": "Flag used to override checks for user-group-quota management operations.\nIf set to `true`, user/group usage is not checked against the `quota_limits` of\nuser-group-quota rules.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a quota policy rule for users or groups.\n" }, { "info": { "name": "Pure Storage PATCH User-group-quota-policies/rules", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/user-group-quota-policies/rules", "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": "ignore_usage", "value": "", "type": "query", "description": "Flag used to override checks for user-group-quota management operations.\nIf set to `true`, user/group usage is not checked against the `quota_limits` of\nuser-group-quota rules.\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 an user-group-quota policy rule.\nOnly the following fields can be modified - `notification` and `quota-limit`.\n\n" }, { "info": { "name": "Pure Storage DELETE User-group-quota-policies/rules", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/user-group-quota-policies/rules", "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": "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": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" } ] }, "docs": "Deletes one or more user-group-quota policy rules.\n\n" }, { "info": { "name": "Pure Storage GET User-group-quota-policies/file-systems", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/user-group-quota-policies/file-systems", "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": "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": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\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": "Lists file systems mapped to a user-group-quota policy." }, { "info": { "name": "Pure Storage POST User-group-quota-policies/file-systems", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/user-group-quota-policies/file-systems", "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": "delete_existing_user_group_quota_settings", "value": "", "type": "query", "description": "This parameter must be set to `true` in order to delete\nexisting quota configurations(default_group_quota, default_user_quota or specific quotas) set\non a file system using either using `quotas/users`, `quotas/groups` or\n`/file-systems`. Setting this parameter to `true` is acknowledgement\nthat the currently configured quotas would be erased before attaching the policy.\nDefaults to `false`.\n" }, { "name": "ignore_usage", "value": "", "type": "query", "description": "Flag used to override checks for user-group-quota management operations.\nIf set to `true`, user/group usage is not checked against the `quota_limits` of\nuser-group-quota rules.\n" }, { "name": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" } ] }, "docs": "Maps a user-group-quota policy to a file system." }, { "info": { "name": "Pure Storage DELETE User-group-quota-policies/file-systems", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/user-group-quota-policies/file-systems", "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": "member_ids", "value": "", "type": "query", "description": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\n" } ] }, "docs": "Removes the user-group-quota policy mapped to a file system." }, { "info": { "name": "Pure Storage GET User-group-quota-policies/members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/user-group-quota-policies/members", "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": "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": "A comma-separated list of member IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `member_ids`, then an error is returned.\nThis cannot be provided together with the `member_names` query parameter.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "A comma-separated list of member names.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The offset of the first resource to return from a collection.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "A comma-separated list of policy IDs.\nIf after filtering, there is not at least one resource that matches\neach of the elements of `policy_ids`, then an error is returned.\nThis cannot be provided together with the `policy_names` query parameter.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "A comma-separated list of policy names.\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": "Lists file systems mapped to a user-group-quota policy." } ] } ], "bundled": true }