{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Policies - SMB Client API", "version": "2.52" }, "items": [ { "info": { "name": "Policies - SMB Client", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage GET Smb-client-policies", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/smb-client-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" }, { "name": "workload_ids", "value": "", "type": "query", "description": "A comma-separated list of workload 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 `workload_names` query parameter.\n" }, { "name": "workload_names", "value": "", "type": "query", "description": "A comma-separated list of workload 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 `workload_ids` query parameter.\n" } ] }, "docs": "Display SMB Client policies and their attributes." }, { "info": { "name": "Pure Storage POST Smb-client-policies", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/smb-client-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": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new SMB Client policy." }, { "info": { "name": "Pure Storage PATCH Smb-client-policies", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/smb-client-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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify an existing SMB Client policy's attributes." }, { "info": { "name": "Pure Storage DELETE Smb-client-policies", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/smb-client-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" } ] }, "docs": "Delete one or more SMB Client policies." }, { "info": { "name": "Pure Storage GET Smb-client-policies/rules", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/smb-client-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": "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": "Displays a list of SMB Client policy rules.\nThe default sort is by policy name, then index.\n" }, { "info": { "name": "Pure Storage POST Smb-client-policies/rules", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/smb-client-policies/rules", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "before_rule_id", "value": "", "type": "query", "description": "The id of the rule to insert or move a rule before.\nThis cannot be provided together with the `before_rule_name` query parameter.\n" }, { "name": "before_rule_name", "value": "", "type": "query", "description": "The name of the rule to insert or move a rule before.\nThis cannot be provided together with the `before_rule_id` query parameter.\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": "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": "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": "Add an SMB Client policy rule.\nRules are ordered in three groups; ip addresses, other and `*`.\nThe new rule will be added at the end of the appropriate group if neither\n`before_rule_id` nor `before_rule_name` are specified.\nRules can only be inserted into the appropriate group.\nThe `policy_ids` or `policy_names` parameter is required, but they cannot be\nset together.\n" }, { "info": { "name": "Pure Storage PATCH Smb-client-policies/rules", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/smb-client-policies/rules", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "before_rule_id", "value": "", "type": "query", "description": "The id of the rule to insert or move a rule before.\nThis cannot be provided together with the `before_rule_name` query parameter.\n" }, { "name": "before_rule_name", "value": "", "type": "query", "description": "The name of the rule to insert or move a rule before.\nThis cannot be provided together with the `before_rule_id` query parameter.\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": "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify an existing SMB Client policy rule.\nIf `before_rule_id` or `before_rule_name` are specified, the rule will be\nmoved before that rule.\nRules are ordered in three groups; ip addresses, other and `*` and can only\nbe moved within the appropriate group.\nOne of the following is required: `ids` or `names`.\n" }, { "info": { "name": "Pure Storage DELETE Smb-client-policies/rules", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/smb-client-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": "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": "Delete one or more SMB Client policy rules.\nOne of the following is required: `ids` or `names`.\n" } ] } ], "bundled": true }