{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Servers API", "version": "2.52" }, "items": [ { "info": { "name": "Servers", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Servers", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/servers", "headers": [ { "name": "Authorization", "value": "" }, { "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 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 name specified.\nEnter multiple 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, `name01,pod01::name01`.\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" }, { "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 a list of servers.\n" }, { "info": { "name": "Pure Storage Create Server", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/servers", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "create_local_directory_service", "value": "", "type": "query", "description": "The name of the local directory service object to be created and associated to the server.\nThis parameter cannot be used together with `local_directory_service` property in the request\nentity.\n" }, { "name": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple 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, `name01,pod01::name01`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a server on the local array.\nThe server must be given a unique name.\n" }, { "info": { "name": "Pure Storage Modify Server", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/servers", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "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": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple 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, `name01,pod01::name01`.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies server details.\n" }, { "info": { "name": "Pure Storage Delete Server", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.52/servers", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "cascade_delete", "value": "directory-services", "type": "query", "description": "The resource types to delete when deleting the object.\nIt will fail if the resources are referenced by other objects.\nValid values include `directory-services`.\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": "names", "value": "", "type": "query", "description": "Performs the operation on the unique name specified.\nEnter multiple 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, `name01,pod01::name01`.\n" } ] }, "docs": "Deletes a server.\n" }, { "info": { "name": "Pure Storage GET Servers", "type": "http" }, "http": { "method": "GET", "url": "/api/2.26/servers", "headers": [ { "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": "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 servers." }, { "info": { "name": "Pure Storage POST Servers", "type": "http" }, "http": { "method": "POST", "url": "/api/2.26/servers", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "create_ds", "value": "server1_nfs", "type": "query", "description": "The name of the directory service object to create used for NFS access to this server.\nThe name must be the server `name` followed by _nfs.\n" }, { "name": "create_local_directory_service", "value": "", "type": "query", "description": "The name of the local directory service object to be created and associated to the server.\nThis parameter cannot be used together with `local_directory_service` property in the request\nentity.\n" }, { "name": "names", "value": "", "type": "query", "description": "A comma-separated list of resource names.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a server." }, { "info": { "name": "Pure Storage PATCH Servers", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.26/servers", "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": "Modify the server attributes." }, { "info": { "name": "Pure Storage DELETE Servers", "type": "http" }, "http": { "method": "DELETE", "url": "/api/2.26/servers", "headers": [ { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "cascade_delete", "value": "directory-services", "type": "query", "description": "The resource types to delete when deleting this object. It will fail if the resources are\nreferenced by other objects.\nValid values include `directory-services`.\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": "Delete a server." } ] } ], "bundled": true }