{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Topology Groups API", "version": "2.52" }, "items": [ { "info": { "name": "Topology Groups", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Topology Groups", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/topology-groups", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "list_all_parents", "value": "", "type": "query", "description": "When set to `true`, the results returned are expanded to also include all ancestors of every topology group matching\n`names` or `ids`. This may only be specified if `names` or `ids` is also specified.\nIf not specified, defaults to `false`.\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": "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": "Lists topology groups." }, { "info": { "name": "Pure Storage Create Topology Groups", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/topology-groups", "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": "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": "parent_topology_group_ids", "value": "", "type": "query", "description": "Assigns selected topology groups to the specified parent topology group by ID.\nOne of the `parent_topology_group_ids` or `parent_topology_group_names` parameters is required,\nbut they cannot be set together.\n" }, { "name": "parent_topology_group_names", "value": "", "type": "query", "description": "Assigns selected topology groups to the specified parent topology group by name.\nOne of the `parent_topology_group_ids` or `parent_topology_group_names` parameters is required,\nbut they cannot be set together.\n" } ] }, "docs": "Creates topology groups. Provide `names` and optionally `parent_topology_group_names` or\n`parent_topology_group_ids` selectors via query parameters.\n" }, { "info": { "name": "Pure Storage Modify Topology Groups", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/topology-groups", "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": "to_parent_topology_group_ids", "value": "", "type": "query", "description": "Moves selected topology groups to the specified parent topology group by ID.\nOne of the `to_parent_topology_group_ids` or `to_parent_topology_group_names` parameters is required,\nbut they cannot be set together.\n" }, { "name": "to_parent_topology_group_names", "value": "", "type": "query", "description": "Moves selected topology groups to the specified parent topology group by name.\nOne of the `to_parent_topology_group_ids` or `to_parent_topology_group_names` parameters is required,\nbut they cannot be set together.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies topology groups. Use the body to rename and the `to_parent_topology_group_names` or\n`to_parent_topology_group_ids` query parameters to move to a parent topology group. Cannot rename\nand move at the\nsame time.\n" }, { "info": { "name": "Pure Storage Delete Topology Groups", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/topology-groups", "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": "Deletes topology groups." }, { "info": { "name": "Pure Storage List Topology Group Arrays", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/topology-groups/arrays", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "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": "topology_group_ids", "value": "", "type": "query", "description": "Selects topology groups by ID. Enter multiple IDs in comma-separated format.\nOne of the `topology_group_ids` or `topology_group_names` parameters is required, but they cannot be set together.\n" }, { "name": "topology_group_names", "value": "", "type": "query", "description": "Selects topology groups by name. Enter multiple names in comma-separated format.\nOne of the `topology_group_ids` or `topology_group_names` parameters is required, but they cannot be set together.\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": "Lists arrays that are members of topology groups. Select topology groups and members via\nquery parameters.\n" }, { "info": { "name": "Pure Storage List Topology Group Members", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/topology-groups/members", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "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": "recursive", "value": "", "type": "query", "description": "If set to `true`, recursively includes all members of a specified topology group.\nMust be used with `topology_group_names` or `topology_group_ids`.\nIf not specified, defaults to `false`.\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": "topology_group_ids", "value": "", "type": "query", "description": "Selects topology groups by ID. Enter multiple IDs in comma-separated format.\nOne of the `topology_group_ids` or `topology_group_names` parameters is required, but they cannot be set together.\n" }, { "name": "topology_group_names", "value": "", "type": "query", "description": "Selects topology groups by name. Enter multiple names in comma-separated format.\nOne of the `topology_group_ids` or `topology_group_names` parameters is required, but they cannot be set together.\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": "Lists topology group members." }, { "info": { "name": "Pure Storage Add Topology Group Members", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/topology-groups/members", "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": "topology_group_ids", "value": "", "type": "query", "description": "Selects topology groups by ID. Enter multiple IDs in comma-separated format.\nOne of the `topology_group_ids` or `topology_group_names` parameters is required, but they cannot be set together.\n" }, { "name": "topology_group_names", "value": "", "type": "query", "description": "Selects topology groups by name. Enter multiple names in comma-separated format.\nOne of the `topology_group_ids` or `topology_group_names` parameters is required, but they cannot be set together.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds members to topology groups. Select the target topology groups via query parameters and provide\nthe\nmembers in the request body.\n" }, { "info": { "name": "Pure Storage Remove Topology Group Members", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/topology-groups/members", "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": "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": "topology_group_ids", "value": "", "type": "query", "description": "Selects topology groups by ID. Enter multiple IDs in comma-separated format.\nOne of the `topology_group_ids` or `topology_group_names` parameters is required, but they cannot be set together.\n" }, { "name": "topology_group_names", "value": "", "type": "query", "description": "Selects topology groups by name. Enter multiple names in comma-separated format.\nOne of the `topology_group_ids` or `topology_group_names` parameters is required, but they cannot be set together.\n" } ] }, "docs": "Removes members from topology groups." } ] } ], "bundled": true }