{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Connections API", "version": "2.52" }, "items": [ { "info": { "name": "Connections", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Volume Connections", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/connections", "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": "filter", "value": "", "type": "query", "description": "Narrows down the results to only the response objects\nthat satisfy the filter criteria.\n" }, { "name": "host_group_names", "value": "", "type": "query", "description": "Performs the operation on the host group specified.\nEnter multiple names in comma-separated format.\nA request cannot include a mix of multiple objects with multiple names.\nFor example, a request cannot include a mix of multiple host group names and volume names;\ninstead, at least one of the objects (e.g., `host_group_names`) must be set to only one name\n(e.g., `hgroup01`).\n" }, { "name": "host_names", "value": "", "type": "query", "description": "Performs the operation on the hosts specified.\nEnter multiple names in comma-separated format.\nFor example, `host01,host02`.\nA request cannot include a mix of multiple objects with multiple names.\nFor example, a request cannot include a mix of multiple host names and volume names;\ninstead, at least one of the objects (e.g., `host_names`) must be set to only one name\n(e.g., `host01`).\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 starting position based on the results of the query\nin relation to the full set of response objects returned.\n" }, { "name": "protocol_endpoint_ids", "value": "", "type": "query", "description": "Performs the operation on the protocol endpoints specified.\nEnter multiple IDs in comma-separated format.\nFor example, `peid01,peid02`.\nA request cannot include a mix of multiple objects with multiple IDs.\nFor example, a request cannot include a mix of multiple protocol endpoint IDs and host names.\nInstead, at least one of the objects (e.g., `protocol_endpoint_ids`) must be set to one ID\n(e.g., `peid01`).\n" }, { "name": "protocol_endpoint_names", "value": "", "type": "query", "description": "Performs the operation on the protocol endpoints specified.\nEnter multiple names in comma-separated format.\nFor example, `pe01,pe02`.\nA request cannot include a mix of multiple objects with multiple names.\nFor example, a request cannot include a mix of multiple protocol endpoint names and host names;\ninstead, at least one of the objects (e.g., `protocol_endpoint_names`) must be set to one name\n(e.g., `pe01`).\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": "volume_ids", "value": "", "type": "query", "description": "Performs the operation on the specified volume.\nEnter multiple ids in comma-separated format.\nFor example, `vol01id,vol02id`.\nA request cannot include a mix of multiple objects with multiple IDs.\nFor example, a request cannot include a mix of multiple volume IDs and host names;\ninstead, at least one of the objects (e.g., `volume_ids`) must be set to only one name\n(e.g., `vol01id`).\nOnly one of the two between `volume_names` and `volume_ids` may be used at a time.\n" }, { "name": "volume_names", "value": "", "type": "query", "description": "Performs the operation on the volume specified.\nEnter multiple names in comma-separated format.\nFor example, `vol01,vol02`.\nA request cannot include a mix of multiple objects with multiple names.\nFor example, a request cannot include a mix of multiple volume names and host names;\ninstead, at least one of the objects (e.g., `volume_names`) must be set to only one name\n(e.g., `vol01`).\n" } ] }, "docs": "Displays a list of connections between a volume and its hosts and host groups, as well as\nthe logical unit numbers (LUNs) or NVMe Namespace IDs (NSIDs) used by the associated hosts\nto address these volumes.\n\n" }, { "info": { "name": "Pure Storage Create a Connection Between a Volume and Host or Host Group", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/connections", "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": "host_group_names", "value": "", "type": "query", "description": "Performs the operation on the host group specified.\nEnter multiple names in comma-separated format.\nA request cannot include a mix of multiple objects with multiple names.\nFor example, a request cannot include a mix of multiple host group names and volume names;\ninstead, at least one of the objects (e.g., `host_group_names`) must be set to only one name\n(e.g., `hgroup01`).\n" }, { "name": "host_names", "value": "", "type": "query", "description": "Performs the operation on the hosts specified.\nEnter multiple names in comma-separated format.\nFor example, `host01,host02`.\nA request cannot include a mix of multiple objects with multiple names.\nFor example, a request cannot include a mix of multiple host names and volume names;\ninstead, at least one of the objects (e.g., `host_names`) must be set to only one name\n(e.g., `host01`).\n" }, { "name": "volume_ids", "value": "", "type": "query", "description": "Performs the operation on the specified volume.\nEnter multiple ids in comma-separated format.\nFor example, `vol01id,vol02id`.\nA request cannot include a mix of multiple objects with multiple IDs.\nFor example, a request cannot include a mix of multiple volume IDs and host names;\ninstead, at least one of the objects (e.g., `volume_ids`) must be set to only one name\n(e.g., `vol01id`).\nOnly one of the two between `volume_names` and `volume_ids` may be used at a time.\n" }, { "name": "volume_names", "value": "", "type": "query", "description": "Performs the operation on the volume specified.\nEnter multiple names in comma-separated format.\nFor example, `vol01,vol02`.\nA request cannot include a mix of multiple objects with multiple names.\nFor example, a request cannot include a mix of multiple volume names and host names;\ninstead, at least one of the objects (e.g., `volume_names`) must be set to only one name\n(e.g., `vol01`).\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a connection between a volume and a host or host group.\nOne of `volume_names` or `volume_ids` and one of `host_names`\nor `host_group_names` query parameters are required.\n\n" }, { "info": { "name": "Pure Storage Delete a Connection Between a Volume and its Host or Host Group", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/connections", "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": "host_group_names", "value": "", "type": "query", "description": "Performs the operation on the host group specified.\nEnter multiple names in comma-separated format.\nA request cannot include a mix of multiple objects with multiple names.\nFor example, a request cannot include a mix of multiple host group names and volume names;\ninstead, at least one of the objects (e.g., `host_group_names`) must be set to only one name\n(e.g., `hgroup01`).\n" }, { "name": "host_names", "value": "", "type": "query", "description": "Performs the operation on the hosts specified.\nEnter multiple names in comma-separated format.\nFor example, `host01,host02`.\nA request cannot include a mix of multiple objects with multiple names.\nFor example, a request cannot include a mix of multiple host names and volume names;\ninstead, at least one of the objects (e.g., `host_names`) must be set to only one name\n(e.g., `host01`).\n" }, { "name": "volume_ids", "value": "", "type": "query", "description": "Performs the operation on the specified volume.\nEnter multiple ids in comma-separated format.\nFor example, `vol01id,vol02id`.\nA request cannot include a mix of multiple objects with multiple IDs.\nFor example, a request cannot include a mix of multiple volume IDs and host names;\ninstead, at least one of the objects (e.g., `volume_ids`) must be set to only one name\n(e.g., `vol01id`).\nOnly one of the two between `volume_names` and `volume_ids` may be used at a time.\n" }, { "name": "volume_names", "value": "", "type": "query", "description": "Performs the operation on the volume specified.\nEnter multiple names in comma-separated format.\nFor example, `vol01,vol02`.\nA request cannot include a mix of multiple objects with multiple names.\nFor example, a request cannot include a mix of multiple volume names and host names;\ninstead, at least one of the objects (e.g., `volume_names`) must be set to only one name\n(e.g., `vol01`).\n" } ] }, "docs": "Deletes the connection between a volume and its associated host or host group.\nOne of `volume_names` or `volume_ids` and one of `host_names`\nor `host_group_names` query parameters are required.\n" } ] } ], "bundled": true }