{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Fleets API", "version": "2.52" }, "items": [ { "info": { "name": "Fleets", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Fleets", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/fleets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "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 unique resource IDs. At least one resource must match\n each specified ID, otherwise an error is returned. This parameter is required\n if ids or names is not provided, but it cannot be used together with name or names.\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 resource names specified.\nOnly one value is supported.\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": "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" } ] }, "docs": "Displays information about the fleets known to the array.\n\n" }, { "info": { "name": "Pure Storage Create a Fleet", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/fleets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n" } ] }, "docs": "Creates a fleet and adds the current array as its first member.\nAdditional arrays can be added to the fleet with `POST /fleets/members`.\n\n" }, { "info": { "name": "Pure Storage Modify a Fleet", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/fleets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "ids", "value": "", "type": "query", "description": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a fleet, changing its name by passing the old name in `name` query parameter, and the\nnew name in the `name` parameter in the request body.\n\n" }, { "info": { "name": "Pure Storage Delete a Fleet", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/fleets", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "ids", "value": "", "type": "query", "description": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n" } ] }, "docs": "Deletes a fleet, permanently.\nA fleet can only be deleted if the current array is the only array in the fleet.\n\n" }, { "info": { "name": "Pure Storage Get Fleet Key Information", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/fleets/fleet-key", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "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": "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" } ] }, "docs": "Displays the time remaining on the fleet key.\nNote, fleet key itself is not displayed, since that is only available at time of fleet key\ncreation.\n\n" }, { "info": { "name": "Pure Storage Create a Fleet Key", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/fleets/fleet-key", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ] }, "docs": "Creates a fleet key allowing an array to be added to a fleet.\nThis is the only time the fleet key is displayed, it cannot be retrieved subsequently.\nNote, creation of a subsequent key invalidates all keys created earlier.\n\n" }, { "info": { "name": "Pure Storage List Fleet Members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/fleets/members", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "fleet_ids", "value": "", "type": "query", "description": "Performs the operation on the unique Fleet IDs specified.\nThis query currently accepts only 1 ID.\n" }, { "name": "fleet_names", "value": "", "type": "query", "description": "Performs the operation on the unique Fleet names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\nThis query currently accepts only 1 name.\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": "Performs the operation on the unique member IDs specified.\nEnter multiple member IDs in comma-separated format.\nThe `member_ids` or `member_names` parameter is required, but they cannot be set together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\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": "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" } ] }, "docs": "Displays the members in the current fleet.\n\n" }, { "info": { "name": "Pure Storage Add Members to a Fleet", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/fleets/members", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "fleet_ids", "value": "", "type": "query", "description": "Performs the operation on the unique Fleet IDs specified.\nThis query currently accepts only 1 ID.\n" }, { "name": "fleet_names", "value": "", "type": "query", "description": "Performs the operation on the unique Fleet names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\nThis query currently accepts only 1 name.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds arrays to an existing fleet. This API needs to be run from the array that's joining the\nfleet.\n\nTo add the current array to the fleet, specify its own array `id` or `name`,\nas well as the `fleet key` generated on any array already in the fleet.\n`resource_type` is `remote-arrays`.\nThe array's `ID` and `name` can be retrieved with a call to `GET /arrays` on the array.\n\n" }, { "info": { "name": "Pure Storage Delete Fleet Members", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/fleets/members", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "member_ids", "value": "", "type": "query", "description": "Performs the operation on the unique member IDs specified.\nEnter multiple member IDs in comma-separated format.\nThe `member_ids` or `member_names` parameter is required, but they cannot be set together.\n" }, { "name": "member_names", "value": "", "type": "query", "description": "Performs the operation on the unique member name specified.\nExamples of members include volumes, hosts, host groups, and directories.\nEnter multiple names in comma-separated format. For example, `vol01,vol02`.\n" }, { "name": "unreachable", "value": "", "type": "query", "description": "If set to `true`, allows a one-sided disconnect when the connection\nstatus is `connecting` instead of `connected` or `partially connected`.\nIf set to `false`, it works just like normal coordinated disconnect.\nIf not specified, defaults to `false`.\n" } ] }, "docs": "Deletes the specified array(s) from the fleet.\nNote that this will only succeed if the array(s) to be removed are not making use of any fleet\nresources.\n\n" }, { "info": { "name": "Pure Storage GET Fleets", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/fleets", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\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 resource names specified.\nOnly one value is supported.\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": "total_only", "value": "", "type": "query", "description": "If set to `true`, returns the aggregate value of all items after filtering.\nWhere it makes more sense, the average value is displayed instead.\nThe values are displayed for each name where meaningful.\nIf `total_only=true`, the `items` list will be empty.\n" } ] }, "docs": "Displays information about the fleets known to the array." }, { "info": { "name": "Pure Storage POST Fleets", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/fleets", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n" } ] }, "docs": "Creates a fleet and adds the current array as its first member.\nAdditional arrays can be added to the fleet with `POST /fleets/members`\n" }, { "info": { "name": "Pure Storage PATCH Fleets", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/fleets", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "ids", "value": "", "type": "query", "description": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Rename a fleet by passing the old name in `name` query parameter, and the new name in the\n`name` parameter in the request body.\n" }, { "info": { "name": "Pure Storage DELETE Fleets", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/fleets", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "ids", "value": "", "type": "query", "description": "Performs the operation on the unique resource IDs specified.\nOnly one value is supported.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique resource names specified.\nOnly one value is supported.\n" } ] }, "docs": "Permanently delete a fleet. A fleet can only be deleted if the current array is the only array\nin the fleet.\n" }, { "info": { "name": "Pure Storage GET Fleet-key", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/fleets/fleet-key", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "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": "total_only", "value": "", "type": "query", "description": "If set to `true`, returns the aggregate value of all items after filtering.\nWhere it makes more sense, the average value is displayed instead.\nThe values are displayed for each name where meaningful.\nIf `total_only=true`, the `items` list will be empty.\n" } ] }, "docs": "Displays the time remaining on the fleet key.\nNote: fleet key itself is not displayed, since that is only available at the time of fleet key\ncreation.\n" }, { "info": { "name": "Pure Storage POST Fleet-key", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/fleets/fleet-key", "headers": [ { "name": "X-Request-ID", "value": "" } ] }, "docs": "Creates a fleet key allowing an array to be added to a fleet.\nThis is the only time the fleet key is displayed, it cannot be retrieved subsequently.\nNote: Creation of a subsequent key invalidates all keys created earlier.\n" }, { "info": { "name": "Pure Storage GET Fleet Members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/fleets/members", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "fleet_ids", "value": "", "type": "query", "description": "Performs the operation on the unique Fleet IDs specified.\nThis query currently accepts only 1 ID.\n" }, { "name": "fleet_names", "value": "", "type": "query", "description": "Performs the operation on the unique Fleet names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\nThis query currently accepts only 1 name.\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": "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": "total_only", "value": "", "type": "query", "description": "If set to `true`, returns the aggregate value of all items after filtering.\nWhere it makes more sense, the average value is displayed instead.\nThe values are displayed for each name where meaningful.\nIf `total_only=true`, the `items` list will be empty.\n" } ] }, "docs": "Displays the members in the current fleet." }, { "info": { "name": "Pure Storage POST Fleets", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/fleets/members", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "fleet_ids", "value": "", "type": "query", "description": "Performs the operation on the unique Fleet IDs specified.\nThis query currently accepts only 1 ID.\n" }, { "name": "fleet_names", "value": "", "type": "query", "description": "Performs the operation on the unique Fleet names specified.\nEnter multiple names in comma-separated format.\nFor example, `name01,name02`.\nThis query currently accepts only 1 name.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds arrays to an existing fleet. This API needs to be run from the array that's joining the\nfleet.\n\nTo add the current array to the fleet, specify its own array id or name as well as the fleet\nkey generated on any array already in the fleet. `resource_type` is `remote-arrays`. The\narray's ID and name can be retrieved with a call to `GET /arrays` on the array.\n" }, { "info": { "name": "Pure Storage Remove Fleet Members", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/fleets/members", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "unreachable", "value": "", "type": "query", "description": "If set to `true`, allows a one-sided disconnect when the connection\nstatus is `connecting` instead of `connected` or `partially connected`.\nIf set to `false`, it works just like normal coordinated disconnect.\nIf not specified, defaults to `false`.\n" } ] }, "docs": "Remove the specified array(s) from the fleet.\nNote: that this will only succeed if the array(s) to be removed are not making use of any fleet\nresources.\n" } ] } ], "bundled": true }