{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Directory Exports API", "version": "2.52" }, "items": [ { "info": { "name": "Directory Exports", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Directory Exports", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/directory-exports", "headers": [ { "name": "Authorization", "value": "" }, { "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": "destroyed", "value": "", "type": "query", "description": "If set to `true`, lists only destroyed objects that are in the eradication pending state.\nIf set to `false`, lists only objects that are not destroyed.\nIf not set, lists both objects that are destroyed and those that are not destroyed.\n\nFor destroyed objects, the time remaining is displayed in milliseconds.\n\nIf object name(s) or id(s) are specified, then each object referenced must exist.\nIf `destroyed` is set to `true`, then each object referenced must also be destroyed.\nIf `destroyed` is set to `false`, then each object referenced must also not be destroyed.\nAn error is returned if any of these conditions are not met.\n" }, { "name": "directory_ids", "value": "", "type": "query", "description": "Performs the operation on the unique managed directory IDs specified.\nEnter multiple managed directory IDs in comma-separated format.\nThe `directory_ids` or `directory_names` parameter is required, but they cannot be set together.\n" }, { "name": "directory_names", "value": "", "type": "query", "description": "Performs the operation on the managed directory names specified.\nEnter multiple full managed directory names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `fs:dir01,pod01::fs:dir01`.\n" }, { "name": "export_names", "value": "", "type": "query", "description": "Performs the operation on the export names specified. Enter multiple names in comma-separated\nformat. For example, `name01,name02`.\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": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple names in comma-separated format.\nCombines the export containment hierarchy (server), the protocol (smb or nfs)\nand the export_name.\nFor example, `server01::smb::export01,server01::nfs::export01`.\n" }, { "name": "offset", "value": "10", "type": "query", "description": "The starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "Performs the operation on the unique policy IDs specified.\nEnter multiple policy IDs in comma-separated format.\nThe `policy_ids` or `policy_names` parameter is required, but they cannot be set together.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "Performs the operation on the policy names specified.\nEnter multiple policy names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `policy01,pod01::policy01`.\n" }, { "name": "sort", "value": "", "type": "query", "description": "Sorts the response objects by the specified fields. Sorting can be applied to any field name\n in the response, in ascending order by default, or in descending order by prefixing the\n field name with a minus sign (-). Multiple fields can be specified as a comma-separated\n list (e.g., sort volumes by size descending, then by name ascending). If sort is provided,\n the response will not include a continuation_token.\n" }, { "name": "total_item_count", "value": "", "type": "query", "description": "If set to `true`, the `total_item_count` matching the\nspecified query parameters is calculated and returned in\nthe response. If set to `false`, the `total_item_count`\nis `null` in the response. This may speed up queries\nwhere the `total_item_count` is large. If not specified,\ndefaults to `false`.\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": "Displays a list of directory exports.\n\n" }, { "info": { "name": "Pure Storage Create Directory Exports", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/directory-exports", "headers": [ { "name": "Authorization", "value": "" }, { "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": "directory_ids", "value": "", "type": "query", "description": "Performs the operation on the unique managed directory IDs specified.\nEnter multiple managed directory IDs in comma-separated format.\nThe `directory_ids` or `directory_names` parameter is required, but they cannot be set together.\n" }, { "name": "directory_names", "value": "", "type": "query", "description": "Performs the operation on the managed directory names specified.\nEnter multiple full managed directory names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `fs:dir01,pod01::fs:dir01`.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple names in comma-separated format.\nCombines the export containment hierarchy (server), the protocol (smb or nfs)\nand the export_name.\nFor example, `server01::smb::export01,server01::nfs::export01`.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "Performs the operation on the unique policy IDs specified.\nEnter multiple policy IDs in comma-separated format.\nThe `policy_ids` or `policy_names` parameter is required, but they cannot be set together.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "Performs the operation on the policy names specified.\nEnter multiple policy names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `policy01,pod01::policy01`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an export of a managed directory.\nThe `directory_ids` or `directory_names` parameter is required, but cannot be set together.\nThe `policy_ids` or `policy_names` parameter is required, but cannot be set together.\nWhen server reference is not provided, the `_array_server` is set as effective default.\nThe API provides two options for identifying an export object. One option is to reference\nit by its fully qualified export name, or alternatively, by a combination of\nparameters—specifically, " }, { "info": { "name": "Pure Storage Modify Directory Exports", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/directory-exports", "headers": [ { "name": "Authorization", "value": "" }, { "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": "directory_ids", "value": "", "type": "query", "description": "Performs the operation on the unique managed directory IDs specified.\nEnter multiple managed directory IDs in comma-separated format.\nThe `directory_ids` or `directory_names` parameter is required, but they cannot be set together.\n" }, { "name": "directory_names", "value": "", "type": "query", "description": "Performs the operation on the managed directory names specified.\nEnter multiple full managed directory names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `fs:dir01,pod01::fs:dir01`.\n" }, { "name": "export_names", "value": "", "type": "query", "description": "Performs the operation on the export names specified. Enter multiple names in comma-separated\nformat. For example, `name01,name02`.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple names in comma-separated format.\nCombines the export containment hierarchy (server), the protocol (smb or nfs)\nand the export_name.\nFor example, `server01::smb::export01,server01::nfs::export01`.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "Performs the operation on the unique policy IDs specified.\nEnter multiple policy IDs in comma-separated format.\nThe `policy_ids` or `policy_names` parameter is required, but they cannot be set together.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "Performs the operation on the policy names specified.\nEnter multiple policy names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `policy01,pod01::policy01`.\n" }, { "name": "server_ids", "value": "", "type": "query", "description": "A comma-separated list of server IDs.\n" }, { "name": "server_names", "value": "", "type": "query", "description": "Server names providing the context for the operation.\nNames are expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `server01,server02`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a directory export.\nUsed for manually renaming, enabling, and disabling directory exports.\nTo rename a directory export, set 'export_name' to the new name.\nWhen server reference is not provided, the `_array_server` is set as effective default.\nThe API provides two options for identifying an export object. One option is to reference\nit by its fully qualified export name, or alternatively, by a combination of\nparameters—specifically, the `server` and `export_name`. All identifying paramet" }, { "info": { "name": "Pure Storage Delete Directory Exports", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/directory-exports", "headers": [ { "name": "Authorization", "value": "" }, { "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": "directory_ids", "value": "", "type": "query", "description": "Performs the operation on the unique managed directory IDs specified.\nEnter multiple managed directory IDs in comma-separated format.\nThe `directory_ids` or `directory_names` parameter is required, but they cannot be set together.\n" }, { "name": "directory_names", "value": "", "type": "query", "description": "Performs the operation on the managed directory names specified.\nEnter multiple full managed directory names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `fs:dir01,pod01::fs:dir01`.\n" }, { "name": "export_names", "value": "", "type": "query", "description": "Performs the operation on the export names specified. Enter multiple names in comma-separated\nformat. For example, `name01,name02`.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple names in comma-separated format.\nCombines the export containment hierarchy (server), the protocol (smb or nfs)\nand the export_name.\nFor example, `server01::smb::export01,server01::nfs::export01`.\n" }, { "name": "policy_ids", "value": "", "type": "query", "description": "Performs the operation on the unique policy IDs specified.\nEnter multiple policy IDs in comma-separated format.\nThe `policy_ids` or `policy_names` parameter is required, but they cannot be set together.\n" }, { "name": "policy_names", "value": "", "type": "query", "description": "Performs the operation on the policy names specified.\nEnter multiple policy names in comma-separated format.\nThe name is expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `policy01,pod01::policy01`.\n" }, { "name": "server_ids", "value": "", "type": "query", "description": "A comma-separated list of server IDs.\n" }, { "name": "server_names", "value": "", "type": "query", "description": "Server names providing the context for the operation.\nNames are expected to be fully qualified, meaning if the object is contained in some context,\nthe corresponding name would provide complete information about the containment hierarchy.\nFor example, `server01,server02`.\n" } ] }, "docs": "Deletes one or more directory exports.\nIf any of the `export_names` is not unique across the system,\n`policy_ids` or `policy_names` must be specified to determine the exports.\nWhen server reference is not provided, the `_array_server` is set as effective default.\nThe API provides two options for identifying an export object. One option is to reference\nit by its fully qualified export name, or alternatively, by a combination of\nparameters-specifically, the `server_names` (or `server_ids`) and `ex" } ] } ], "bundled": true }