--- title: "Get a vm recovery point" method: GET path: "/vm_recovery_points/{uuid}" tags: ["vm_recovery_points"] --- # Get a vm recovery point `GET /vm_recovery_points/{uuid}` This operation gets a vm recovery point. ## Path parameters - `uuid` string, UUID, required ## Response `200` Success - VmRecoveryPointIntentResponse — Response object for intentful operations on a vm_recovery_point - `status` VmRecoveryPointDefStatus — The output object that defines a vm recovery point - `state` string — The state of the vm recovery point. - `name` string — Name of the recovery point. - `availability_zone_reference` AvailabilityZoneReference — The reference to a availability_zone - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `message_list` MessageResource[] — Any error messages for the vm, if in an error state. - `message` string, required — If state is ERROR, a message describing the error. - `reason` string, required — If state is ERROR, a machine-readable snake-cased string. - `details` object — Custom key-value details relevant to the status. - `cluster_reference` ClusterReference — The reference to a cluster - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `resources` object - `consistency_group_uuid` string — This field is same for all the entities (irrespective of kind) that were snapshotted together. - `source_cluster_reference` ClusterReference — The reference to a cluster - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `source_availability_zone_reference` AvailabilityZoneReference — The reference to a availability_zone - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `parent_vm_reference` VmReference — The reference to a vm - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `recovery_point_type` string — Crash consistent or Application Consistent recovery point - `vm_spec` Vm — An intentful representation of a vm spec - `description` string — A description for vm. - `resources` VmResources, required — VM Resources Definition. - `power_state` string — The current or desired power state of the VM. - `num_vcpus_per_socket` integer — Number of vCPUs per socket. - `num_sockets` integer — Number of vCPU sockets. - `gpu_list` VmGpu[] — GPUs attached to the VM. - `vendor` string — The vendor of the GPU. - `mode` string — The mode of this GPU. - `device_id` integer — The device ID of the GPU. - `memory_size_mib` integer — Memory size in MiB. - `boot_config` VmBootConfig — Indicates which device a VM should boot from. - `boot_device_order_list` string[] — Indicates the order of device types in which VM should try to boot from. If boot device order is not provided the system will decide appropriate boot device order. - `boot_device` VmBootDevice — Indicates which device a VM should boot from. One of disk_address or mac_address should be provided. - … - `hardware_clock_timezone` string — VM's hardware clock timezone in IANA TZDB format (America/Los_Angeles). - `guest_customization` GuestCustomization — VM guests may be customized at boot time using one of several different methods. Currently, cloud-init w/ ConfigDriveV2 (for Linux VMs) and Sysprep (for Windows VMs) are supported. Only ONE OF sysprep or cloud_init should be provided. Note that guest customization can currently only be set during VM creation. Attempting to change it after creation will result in an error. Additional properties can be specified. For example - in the context of VM template creation if "override_script" is set to "True" then the deployer can upload their own custom script. - `cloud_init` object — If this field is set, the guest will be customized using cloud-init. Either user_data or custom_key_values should be provided. If custom_key_ves are provided then the user data will be generated using these key-value pairs. - … - `is_overridable` boolean — Flag to allow override of customization by deployer. - `sysprep` object — If this field is set, the guest will be customized using Sysprep. Either unattend_xml or custom_key_values should be provided. If custom_key_values are provided then the unattended answer file will be generated using these key-value pairs. - … - `power_state_mechanism` VmPowerStateMechanism — Indicates the mechanism guiding the VM power state transition. Currently used for the transition to "OFF" state. - `guest_transition_config` VmGuestPowerStateTransitionConfig — Extra configs related to power state transition. - … - `mechanism` string — Power state mechanism (ACPI/GUEST/HARD). - `vga_console_enabled` boolean — Indicates whether VGA console should be enabled or not. - `disk_list` VmDisk[] — Disks attached to the VM. - `volume_group_reference` Reference — Reference to a kind - … - `device_properties` object - … - `uuid` string, UUID — The device ID which is used to uniquely identify this particular disk. - `data_source_reference` Reference — Reference to a kind - … - `disk_size_mib` integer — Size of the disk in MiB. Must match the size specified in 'disk_size_bytes' - rounded up to the nearest MiB - when that field is present. - `disk_size_bytes` integer — Size of the disk in Bytes. - `vnuma_config` VmVnumaConfig — Indicates how VM vNUMA should be configured - `num_vnuma_nodes` integer — Number of vNUMA nodes. 0 means vNUMA is disabled. - `nic_list` VmNic[] — NICs attached to the VM. - `nic_type` string — The type of this NIC. Defaults to NORMAL_NIC. - `uuid` string, UUID — The NIC's UUID, which is used to uniquely identify this particular NIC. This UUID may be used to refer to the NIC outside the context of the particular VM it is attached to. - `ip_endpoint_list` IpAddress[] — IP endpoints for the adapter. Currently, IPv4 addresses are supported. - … - `network_function_chain_reference` NetworkFunctionChainReference — The reference to a network_function_chain - … - `network_function_nic_type` string — The type of this Network function NIC. Defaults to INGRESS. - `mac_address` string — The MAC address for the adapter. - `subnet_reference` SubnetReference — The reference to a subnet - … - `model` string — The model of this NIC. - `is_connected` boolean — Whether or not the NIC is connected. True by default. - `guest_os_id` string — Guest OS Identifier. For ESX, refer to VMware documentation link (https://www.vmware.com/support/developer/converter-sdk/conv43_apireference/vim.vm.GuestOsDescriptor.GuestOsIdentifier.html) for the list of guest OS identifiers. - `serial_port_list` SerialPort[] — Serial ports configured on the VM. - `index` integer — Index of the serial port. - `is_connected` boolean — Indicates whether the serial port connection is connected or not. - `guest_tools` GuestToolsSpec — Information regarding guest tools. - `nutanix_guest_tools` NutanixGuestToolsSpec — Information regarding Nutanix Guest Tools. - … - `storage_qos_policy_config` StorageQosPolicyConfigInput — The policy rule to be enforced depending on the type of policy. For ex - provisioned/throttled iops would be set for a storage qos policy. - `provisioned_iops` integer, required — Provisioned iops for the entities being governed by the policy. - `throttled_iops` integer, required — Throttled iops for the entities being governed by the policy. - `parent_reference` Reference — Reference to a kind - `kind` string, required - `uuid` string, UUID, required - `name` string - `cluster_reference` ClusterReference — The reference to a cluster - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `name` string, required — vm Name. - `availability_zone_reference` AvailabilityZoneReference — The reference to a availability_zone - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `vm_recovery_point_location_agnostic_uuid` string, UUID — Location agnostic UUID of the recovery point. If a recovery point is replicated to a different clusters, then all the instances of same recovery point will share this UUID. - `creation_time` string — The time when the the recovery point is created. This is in internet date/time format (RFC 3339). For example, 1985-04-12T23:20:50.52Z, this represents 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. - `vm_metadata` VmMetadata — The vm kind metadata - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when vm was last updated - `kind` string, required — The kind name - `uuid` string, UUID — vm uuid - `spec_version` integer — Version number of the latest spec. - `creation_time` string, date-time — UTC date and time in RFC-3339 format when vm was created - `spec_hash` string — Hash of the spec. This will be returned from server. - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema. - `owner_reference` UserReference — The reference to a user - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `categories` object — Categories for the vm - `name` string — vm name - `expiration_time` string, date-time — The time when this recovery point expires and will be garbage collected. This is in internet date/time format (RFC 3339). For example, 1985-04-12T23:20:50.52Z, this represents 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. If not set, then the recovery point never expires. - `spec` VmRecoveryPoint — The input object that defines a vm recovery point. - `availability_zone_reference` AvailabilityZoneReference — The reference to a availability_zone - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `cluster_reference` ClusterReference — The reference to a cluster - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `resources` object - `vm_recovery_point_location_agnostic_uuid` string — Location agnostic UUID of the recovery point. If a recovery point is replicated to a different clusters, then all the instances of same recovery point will share this UUID. - `source_cluster_reference` ClusterReference — The reference to a cluster - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `source_availability_zone_reference` AvailabilityZoneReference — The reference to a availability_zone - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `parent_vm_reference` VmReference — The reference to a vm - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `recovery_point_type` string — Crash consistent or Application Consistent recovery point - `creation_time` string, date-time — The time when the the recovery point is created. This is in internet date/time format (RFC 3339). For example, 1985-04-12T23:20:50.52Z, this represents 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. - `expiration_time` string, date-time — The time when this recovery point expires and will be garbage collected. This is in internet date/time format (RFC 3339). For example, 1985-04-12T23:20:50.52Z, this represents 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. If not set, then the recovery point never expires. - `name` string — Name of the recovery point. - `api_version` string, required - `metadata` VmRecoveryPointMetadata, required — The vm_recovery_point kind metadata - `last_update_time` string, date-time — UTC date and time in RFC-3339 format when vm_recovery_point was last updated - `kind` string, required — The kind name - `uuid` string, UUID — vm_recovery_point uuid - `project_reference` ProjectReference — The reference to a project - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `spec_version` integer — Version number of the latest spec. - `creation_time` string, date-time — UTC date and time in RFC-3339 format when vm_recovery_point was created - `spec_hash` string — Hash of the spec. This will be returned from server. - `should_force_translate` boolean — Applied on Prism Central only. Indicate whether force to translate the spec of the fanout request to fit the target cluster API schema. - `owner_reference` UserReference — The reference to a user - `kind` string, required — The kind name - `name` string - `uuid` string, UUID, required - `categories` object — Categories for the vm_recovery_point - `name` string — vm_recovery_point name ## Other responses - `404` — Invalid UUID provided - `default` — Internal Error --- [API](https://skmtc.net/nutanix/apis/nutanix-intentful-api.md) · [All operations](https://skmtc.net/nutanix/apis/nutanix-intentful-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nutanix/nutanix-intentful-api/revisions/40395083ab31/schema)