{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Node Groups API", "version": "2.52" }, "items": [ { "info": { "name": "Node Groups", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage GET Node-groups", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/node-groups", "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": "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": "Display all array node groups." }, { "info": { "name": "Pure Storage POST Node-groups", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/node-groups", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "Create one or more node groups on the array." }, { "info": { "name": "Pure Storage PATCH Node-groups", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/node-groups", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "Update one or more node groups on the array." }, { "info": { "name": "Pure Storage DELETE Node-groups", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/node-groups", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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 node groups from the array." }, { "info": { "name": "Pure Storage GET Node-groups/nodes", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/node-groups/nodes", "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": "node_group_ids", "value": "", "type": "query", "description": "A comma-separated list of node group ids.\nIf there is not at least one resource that matches each of the\nelements of `node_group_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `node_group_names` parameter.\n" }, { "name": "node_group_names", "value": "", "type": "query", "description": "A comma-separated list of node group names.\nIf there is not at least one resource that matches each of the\nelements of `node_group_names`, then an error is returned.\nThis cannot be provided in conjunction with the `node_group_ids` parameter.\n" }, { "name": "node_ids", "value": "", "type": "query", "description": "A comma-separated list of node ids.\nIf there is not at least one resource that matches each of the\nelements of `node_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `node_names`\nparameter.\n" }, { "name": "node_names", "value": "", "type": "query", "description": "A comma-separated list of node names.\nIf there is not at least one resource that matches each of the\nelements of `node_names`, then an error is returned.\nThis cannot be provided in conjunction with the `node_ids`\nparameter.\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": "List membership associations between node groups and nodes on the array." }, { "info": { "name": "Pure Storage POST Node-groups/nodes", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/node-groups/nodes", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "node_group_ids", "value": "", "type": "query", "description": "A comma-separated list of node group ids.\nIf there is not at least one resource that matches each of the\nelements of `node_group_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `node_group_names` parameter.\n" }, { "name": "node_group_names", "value": "", "type": "query", "description": "A comma-separated list of node group names.\nIf there is not at least one resource that matches each of the\nelements of `node_group_names`, then an error is returned.\nThis cannot be provided in conjunction with the `node_group_ids` parameter.\n" }, { "name": "node_ids", "value": "", "type": "query", "description": "A comma-separated list of node ids.\nIf there is not at least one resource that matches each of the\nelements of `node_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `node_names`\nparameter.\n" }, { "name": "node_names", "value": "", "type": "query", "description": "A comma-separated list of node names.\nIf there is not at least one resource that matches each of the\nelements of `node_names`, then an error is returned.\nThis cannot be provided in conjunction with the `node_ids`\nparameter.\n" } ] }, "docs": "Add one or more nodes to one or more node groups on the array." }, { "info": { "name": "Pure Storage DELETE Node-groups/nodes", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/node-groups/nodes", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "node_group_ids", "value": "", "type": "query", "description": "A comma-separated list of node group ids.\nIf there is not at least one resource that matches each of the\nelements of `node_group_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `node_group_names` parameter.\n" }, { "name": "node_group_names", "value": "", "type": "query", "description": "A comma-separated list of node group names.\nIf there is not at least one resource that matches each of the\nelements of `node_group_names`, then an error is returned.\nThis cannot be provided in conjunction with the `node_group_ids` parameter.\n" }, { "name": "node_ids", "value": "", "type": "query", "description": "A comma-separated list of node ids.\nIf there is not at least one resource that matches each of the\nelements of `node_ids`, then an error is returned.\nThis cannot be provided in conjunction with the `node_names`\nparameter.\n" }, { "name": "node_names", "value": "", "type": "query", "description": "A comma-separated list of node names.\nIf there is not at least one resource that matches each of the\nelements of `node_names`, then an error is returned.\nThis cannot be provided in conjunction with the `node_ids`\nparameter.\n" } ] }, "docs": "Remove one or more nodes from one or more groups." }, { "info": { "name": "Pure Storage GET Node-groups/uses", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/node-groups/uses", "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": "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": "List how node groups are being used and by what." } ] } ], "bundled": true }