{ "opencollection": "1.0.0", "info": { "name": "FlashArray REST Active Directory Virtual Machines API", "version": "2.52" }, "items": [ { "info": { "name": "Virtual Machines", "type": "folder" }, "items": [ { "info": { "name": "Pure Storage List Virtual Machines", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/virtual-machines", "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": "destroyed", "value": "", "type": "query", "description": "If set to `true`, lists only destroyed objects that are in the eradication pending state.\nIf set to `false`, lists only objects that are not destroyed.\nIf not set, lists both objects that are destroyed and those that are not destroyed.\n\nFor destroyed objects, the time remaining is displayed in milliseconds.\n\nIf object name(s) or id(s) are specified, then each object referenced must exist.\nIf `destroyed` is set to `true`, then each object referenced must also be destroyed.\nIf `destroyed` is set to `false`, then each object referenced must also not be destroyed.\nAn error is returned if any of these conditions are not met.\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" }, { "name": "vm_ids", "value": "", "type": "query", "description": "Performs the operation on the unique virtual machine IDs specified.\nEnter multiple virtual machine IDs in a comma-separated format.\n" }, { "name": "vm_type", "value": "", "type": "query", "description": "The type of virtual machine.\nThe only valid value is `vvol`.\n" } ] }, "docs": "Displays a list of virtual machines, including those pending eradication.\nIf `vm_type` is `vvol`, the `recovery_context` in the response will represent\nthe most recent snapshot of the config vVol. This must be used as the `source` in\nthe `PATCH` method when recovering a virtual machine from the destroyed state.\n\n" }, { "info": { "name": "Pure Storage Create a Virtual Machine", "type": "http" }, "http": { "method": "POST", "url": "/api/2.52/virtual-machines", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "params": [ { "name": "overwrite", "value": "", "type": "query", "description": "If set to `true`,\noverwrites an existing object during an object copy operation.\nIf set to `false` or not set at all and the target name is an existing object,\nthe copy operation fails.\nRequired if the `source` body parameter is set\nand the source overwrites an existing object during the copy operation.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates one or more virtual machines from a protection group snapshot.\nIf the virtual machine is of type `vvol`, the `source` property of the request body must\nbe a `recovery_context` value retrieved from the `GET /virtual-machine-snapshots` endpoint.\nIf `overwrite` is specified, an existing virtual machine will have its volumes overwritten by\nthe snapshot. Otherwise, a new virtual machine will be created from the snapshot.\nIf creating the new virtual machine will cause a conflict with an existi" }, { "info": { "name": "Pure Storage Update a Virtual Machine", "type": "http" }, "http": { "method": "PATCH", "url": "/api/2.52/virtual-machines", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Request-ID", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a virtual machine, recovering it from the destroyed state.\nIf the virtual machine is of type `vvol`, the `source` property of the request body must\nbe a `recovery_context` value retrieved from the `GET /virtual-machines` endpoint.\nIf recovering the virtual machine will cause a conflict with an existing virtual machine, the\noperation will fail.\n\n" }, { "info": { "name": "Pure Storage List Virtual Machine Volume Snapshots", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/virtual-machine-volume-snapshots", "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": "destroyed", "value": "", "type": "query", "description": "If set to `true`, lists only destroyed objects that are in the eradication pending state.\nIf set to `false`, lists only objects that are not destroyed.\nIf not set, lists both objects that are destroyed and those that are not destroyed.\n\nFor destroyed objects, the time remaining is displayed in milliseconds.\n\nIf object name(s) or id(s) are specified, then each object referenced must exist.\nIf `destroyed` is set to `true`, then each object referenced must also be destroyed.\nIf `destroyed` is set to `false`, then each object referenced must also not be destroyed.\nAn error is returned if any of these conditions are not met.\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" }, { "name": "vm_ids", "value": "", "type": "query", "description": "Performs the operation on the unique virtual machine IDs specified.\nEnter multiple resource IDs in a comma-separated format.\n" }, { "name": "vm_type", "value": "", "type": "query", "description": "The type of virtual machine.\nThe only valid value is `vvol`.\n" } ] }, "docs": "Displays a list of virtual machine volume snapshots, including those pending eradication.\nIf `vm_type` is `vvol`, the `recover_context` in the response will represent\na protection group snapshot containing the virtual machine volume.\n\n" }, { "info": { "name": "Pure Storage List Virtual Machine Snapshots", "type": "http" }, "http": { "method": "GET", "url": "/api/2.52/virtual-machine-snapshots", "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": "destroyed", "value": "", "type": "query", "description": "If set to `true`, lists only destroyed objects that are in the eradication pending state.\nIf set to `false`, lists only objects that are not destroyed.\nIf not set, lists both objects that are destroyed and those that are not destroyed.\n\nFor destroyed objects, the time remaining is displayed in milliseconds.\n\nIf object name(s) or id(s) are specified, then each object referenced must exist.\nIf `destroyed` is set to `true`, then each object referenced must also be destroyed.\nIf `destroyed` is set to `false`, then each object referenced must also not be destroyed.\nAn error is returned if any of these conditions are not met.\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" }, { "name": "vm_ids", "value": "", "type": "query", "description": "Performs the operation on the unique virtual machine IDs specified.\nEnter multiple resource IDs in a comma-separated format.\n" }, { "name": "vm_type", "value": "", "type": "query", "description": "The type of virtual machine.\nThe only valid value is `vvol`.\n" } ] }, "docs": "Displays a list of virtual machine snapshots, including those pending eradication.\nIf `vm_type` is `vvol`, the `recovery_context` in the response will represent\na protection group snapshot containing the virtual machine. This must be used as\nthe `source` in the `POST /virtual-machine` method when recovering or overwriting a\nvirtual machine from a snapshot.\n\n" } ] } ], "bundled": true }