---
name: vpc-api-metadata-change-log
title: VPC Metadata API change log
description: Read the API change log to learn about updates and improvements to the IBM Cloud® Virtual Private Cloud (VPC) Metadata API. Change log announcements are ordered by the date that they were released. Changes to existing API versions are designed to be compatible with existing client applications.
last-updated: 2026-06-26
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/vpc?format=markdown
> The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt
> Use these files to discover more information as needed.

# VPC Metadata API change log
{: #metadata-api-change-log}

Read the API change log to learn about updates and improvements to the IBM Cloud® Virtual Private Cloud (VPC) [Metadata API](https://cloud.ibm.com/docs/apis/vpc-metadata). Change log announcements are ordered by the date that they were released. Changes to existing API versions are designed to be compatible with existing client applications.
{: shortdesc}

By design, new features with backward-incompatible changes apply only to version dates on and after the feature's release. Changes that apply to older versions of the API are designed to maintain compatibility with existing applications and code. If backward-incompatible changes require non-trivial client code changes to use an API version, the API change log might provide links to instructions, tips, or best practices for updating client code.
{: note}

Some changes, such as new response properties or new optional request parameters, are considered compatible with earlier versions. Other changes, such as new required request parameters, are not considered backward compatible. To avoid disruption from changes to the API, use the following best practices when you call the API:

- Catch and log any `4xx` or `5xx` HTTP status code, along with the included `trace` property
- Follow HTTP redirect rules for any `3xx` HTTP status code
- Consume only the resources and properties that your application needs to function
- Avoid depending on behavior that is not explicitly documented

## 23 June 2026
{: #23-june-2026-metadata}

### For all version dates
{: #23-june-2026-all-version-dates-metadata}

**Instance third-party license and entitlement service.** The VPC Metadata service now provides access to software license entitlements for instances provisioned with vendor-managed licensing. Vendor agents running on instances can view license keys when [retrieving](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance-software-attachment) or [listing](https://cloud.ibm.com/docs/apis/vpc-metadata#list-instance-software-attachments) software attachments.

For more information, see [Accessing the instance metadata service](https://cloud.ibm.com/docs/vpc?topic=vpc-imd-access-instance-metadata&interface=api&format=markdown).

**AMD high frequency Turin VSI profiles.** When [retrieving an instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance), the response now includes the  `threads_per_core` property. This field specifies the number of threads configured per core. For [High Frequency gen4 profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-high-frequency-profile-family&format=markdown) the `threads_per_core` value can be either `1` or `2`. For all other profiles, the value defaults to `2`.

For more information, see [Accessing the instance metadata service](https://cloud.ibm.com/docs/vpc?topic=vpc-imd-access-instance-metadata&interface=api&format=markdown)

## 20 January 2026
{: #20-january-2026-metadata}

### For all version dates
{: #20-january-2026-all-version-dates-metadata}

**Spot instances.** Accounts that have special approval to preview this feature now see the `availability.class` and `availability_policy.preemption` properties included in the response when [retrieving an instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance). The `availability.class` property indicates the availability class of the instance as `spot` or `standard`. The `availability_policy.preemption` property indicates the behavior as `stop` or `delete` when the instance is preempted. For more information, see the [VPC API change log](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#20-january-2026) and [Spot instances](https://cloud.ibm.com/docs/vpc?topic=vpc-spot-instances-virtual-servers&format=markdown).

## 16 December 2025
 {: #16-december-2025-metadata}

 **Burstable (shared core) instances.** When [retrieving an instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance), the `vcpu.percentage` property is now included in the response. This property indicates the percentage of vcpu time available to your instance. Additionally, the `vcpu.burst.limit` property is included in the response. This property indicates the percentage limit that the instance can burst. For more information, see [burstable virtual server instances](https://cloud.ibm.com/docs/vpc?topic=vpc-burstable-virtual-servers&format=markdown).

## 30 September 2025
{: #23-september-2025-metadata}

### For all version dates
{: #30-september-2025-all-version-dates-metadata}

**Dynamic volume bandwidth allocation.** When [retrieving an instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance), the `volume_bandwidth_qos_mode` property is now included in the response. This property indicates which volume bandwidth QoS mode is enabled for this virtual server instance. Its value can be either `weighted` or `pooled`. For more information, see the [VPC API change log](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#30-september-2025) and [volume bandwidth QoS mode](https://cloud.ibm.com/docs/vpc?topic=vpc-block-storage-bandwidth&format=markdown).

## 26 August 2025
{: #26-august-2025-metadata}

### For all version dates
{: #26-august-2025-all-version-dates-metadata}

**Access tokens and Certificates methods.** The existing access tokens and certificates methods in the [VPC Metadata API](https://cloud.ibm.com/docs/apis/vpc-metadata) are documented in the new [VPC Identity API](https://cloud.ibm.com/docs/apis/vpc-identity). For details, see the [VPC Identity change log](https://cloud.ibm.com/docs/vpc?topic=vpc-identity-api-change-log&format=markdown#26-august-2025-identity).

## 1 April 2025
{: #1-april-2025-metadata}

### For all version dates
{: #1-april-2025-all-version-dates-metadata}

**Trust Domain Extensions for confidential computing.** In select regions, you can now enable [Intel® Trust Domain Extensions (TDX)](https://cloud.ibm.com/docs/vpc?topic=vpc-about-confidential-computing-vpc&format=markdown#confidential-computing-vpc-with-tdx). If it is enabled for this virtual server instance, then when [retrieving an instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance), the `confidential_compute_mode` property has the value `tdx`. For more information, see the [VPC API change log](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#1-april-2025).

## 12 November 2024
{: #12-november-2024-metadata}

### For all version dates
{: #12-november-2024-all-version-dates-metadata}

**Instance cluster network attachments.** If a virtual server instance has cluster network attachments, [retrieving the instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance) now includes a `cluster_network_attachments` property in the response. Additionally, you can [retrieve an instance cluster network attachment](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance-cluster-network-attachment) for more details on the instance's cluster network attachments. For more information, see the [VPC API change log](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#12-november-2024).

## 4 June 2024
{: #4-june-2024-metadata}

### For all version dates
{: #4-june-2024-all-version-dates-metadata}

**Enhancements in support of catalog offering plans.** When [retrieving an instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance) that was provisioned with a [billed catalog offering](https://cloud.ibm.com/docs/vpc?topic=vpc-getting-started-images-on-vpc-catalog&interface=ui&format=markdown#images-on-vpc-catalog-images), the new `catalog_offering.plan.crn` property provides the associated billing plan. For more information, see [Provisioning instances with IBM Cloud billable catalog offering](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#4-june-2024) in the VPC API change log.

## 28 May 2024
{: #28-may-2024-metadata}

### For all version dates
{: #28-may-2024-all-version-dates-metadata}

**Virtual network interface protocol state filtering mode.** When [retrieving](https://cloud.ibm.com/docs/apis/vpc-metadata#get-virtual-network-interface) or [listing](https://cloud.ibm.com/docs/apis/vpc-metadata#list-virtual-network-interfaces) virtual network interfaces, the new `protocol_state_filtering_mode` property denotes the protocol state filtering mode that is used for this virtual network interface. If the value is `auto`, protocol state packet filtering is enabled or disabled based on the virtual network interface's `target` resource type. For more information, see [Virtual network interfaces protocol state filtering](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#28-may-2024) in the VPC API change log.

This release introduces the following updates for accounts that have special approval to preview these features:

**Confidential computing capabilities.** If [Intel® Software Guard Extensions](https://cloud.ibm.com/docs/vpc?topic=vpc-about-confidential-computing-vpc&format=markdown) are enabled on an instance or instance template, you can view the new `confidential_compute_mode` property, which indicates that confidential compute mode is enabled for this virtual server instance. For more information, see the [VPC API change log](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#28-may-2024).

**Secure boot capabilities.** If [secure boot](https://cloud.ibm.com/docs/vpc?topic=vpc-confidential-computing-with-secure-boot-vpc&format=markdown) is enabled on an instance or instance template, you can view the new `enable_secure_boot` property when [retrieving an instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance). This property indicates whether secure boot is enabled for this virtual server instance. For more information, see the [VPC API change log](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#28-may-2024).

## 26 March 2024
{: #26-march-2024-metadata}

### For all version dates
{: #26-march-2024-all-version-dates-metadata}

**Reservations for Virtual Servers for VPC.** You can now purchase a [capacity reservation](https://cloud.ibm.com/docs/vpc?topic=vpc-about-reserved-virtual-servers-vpc&format=markdown) for a specified instance profile in a specified zone. When [retrieving an instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance), the new `reservation` and `reservation_affinity` properties indicate the reservation and reservation affinity policy in effect for the virtual server instance. The new `health_state` property indicates the instance's overall health state, while an accompanying `health_reasons` property indicates the reason for any unhealthy health states, such as a failed reservation.

For more information, see the [API change log](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#26-march-2024) and [Provisioning reserved capacity for VPC](https://cloud.ibm.com/docs/vpc?topic=vpc-provisioning-reserved-capacity-vpc&format=markdown).

## 30 January 2024
{: #30-january-2024-metadata}

### For all version dates
{: #30-january-2024-all-version-dates-metadata}

**Reservations for Virtual Servers for VPC.** Accounts that have special approval to preview this feature can now purchase a [capacity reservation](https://cloud.ibm.com/docs/vpc?topic=vpc-about-reserved-virtual-servers-vpc&format=markdown) for a specified instance profile in a specified zone. When [retrieving an instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance), the new `reservation` and `reservation_affinity` properties indicate the reservation and reservation affinity policy in effect for the virtual server instance. The new `health_state` property indicates the instance's overall health state, while an accompanying `health_reasons` property indicates the reason for any unhealthy health states, such as a failed reservation.

For more information, see the [API change log](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#30-january-2024) and [Provisioning reserved capacity for VPC](https://cloud.ibm.com/docs/vpc?topic=vpc-provisioning-reserved-capacity-vpc&format=markdown).

This feature is now generally available. See the [26 March 2024](#26-march-2024-metadata) announcement.

## 19 December 2023
{: #19-december-2023-metadata}

### For all version dates
{: #19-december-2023-all-version-dates-metadata}

**Virtual network interface support.** Accounts that have special approval can preview a new feature that expands the support for [virtual network interfaces](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about&format=markdown). You can now [list](https://cloud.ibm.com/docs/apis/vpc-metadata#list-instance-network-attachments) or [view](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance-network-attachment) an instance's network attachments, and you can [list](https://cloud.ibm.com/docs/apis/vpc-metadata#list-virtual-network-interfaces) or [view](https://cloud.ibm.com/docs/apis/vpc-metadata#get-virtual-network-interface) virtual network interfaces targeting the instance. For compatibility with existing clients, an instance with virtual network interfaces now includes a read-only representation of its network attachments and virtual network interfaces as legacy network interface child resources. For more information, see the [API change log](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#19-december-2023), and learn about [support for old API clients](https://cloud.ibm.com/docs/vpc?topic=vpc-vni-about&interface=ui&format=markdown#vni-old-api-clients).

## 17 October 2023
{: #17-october-2023-metadata}

### For all version dates
{: #17-october-all-version-dates-metadata}

**Non-uniform memory access (NUMA) awareness on instances.** When [retrieving an instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance), the new `numa_count` property indicates the number of NUMA nodes on which a virtual server instance is provisioned. For more information, see [Next generation instance profiles](https://cloud.ibm.com/docs/vpc?topic=vpc-profiles&interface=api&format=markdown#next-gen-profiles). See also [Non-uniform memory access (NUMA) awareness on dedicated hosts and instances](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#17-october-2023) in the VPC API change log.

## 15 August 2023
{: #15-august-2023-metadata}

### For all version dates
{: #15-august-2023-all-version-dates-metadata}

**Instance identity certificates.** You can now use the instance identity access token and a certificate signing request (CSR) to [create](https://cloud.ibm.com/docs/apis/vpc-metadata#create-certificate) an instance identity certificate. For more information, see [Generating an instance identity certificate by using an instance identity access token](https://cloud.ibm.com/docs/vpc?topic=vpc-imd-identity-operations&interface=api&format=markdown#imd-acquire-certificate). Instance identity certificates are used when the traffic between an authorized client and the mounted file share is [encrypted in transit](https://cloud.ibm.com/docs/vpc?topic=vpc-file-storage-vpc-eit&format=markdown).

## 27 June 2023
{: #27-june-2023-metadata}

### For all version dates
{: #27-june-2023-all-version-dates-metadata}

**Extended SSH key encryption.** The `type` property now includes `ed25519` when [retrieving](https://cloud.ibm.com/docs/apis/vpc-metadata#get-key) or [listing](https://cloud.ibm.com/docs/apis/vpc-metadata#list-keys) public SSH keys. For more information, see [Getting started with SSH keys](https://cloud.ibm.com/docs/vpc?topic=vpc-ssh-keys&interface=api&format=markdown). See also [Extended SSH key encryption](https://cloud.ibm.com/docs/vpc?topic=vpc-api-change-log&format=markdown#27-june-2023) in the VPC API change log.

## 14 February 2023
{: #14-february-2023-metadata}

### For all version dates
{: #14-february-2023-all-version-dates-metadata}

**VPC Metadata new endpoint URL.** You can now use the fully qualified domain name (FQDN) `api.metadata.cloud.ibm.com` for the VPC Metadata service endpoint. The FQDN resolves to the link-local IP address `169.254.169.254` without requiring the application of special configurations. For more information, see [Endpoint URLs](https://cloud.ibm.com/docs/apis/vpc-metadata#endpoint-url-metadata) in the VPC Metadata API.

**VPC Metadata communication protocol and hop limit.** You can now view the communication protocol and hop limit for IP response packets that are used by the [VPC Metadata service](https://cloud.ibm.com/docs/vpc?topic=vpc-imd-about&format=markdown). When [retrieving the instance](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance), the new `protocol` and `response_hop_limit` properties are shown. For more information, see [Configure the Metadata service](https://cloud.ibm.com/docs/vpc?topic=vpc-imd-configure-service&interface=api&format=markdown).

## 27 September 2022
{: #27-september-2022-metadata}

### For all version dates
{: #27-september-2022-all-version-dates-metadata}

**Sharing images across an enterprise account.** If a virtual server instance was provisioned from a catalog offering, [retrieving the metadata](https://cloud.ibm.com/docs/apis/vpc-metadata#get-instance) now includes a `catalog_offering` property in the response. For more information, see the [Virtual Private Cloud Metadata API](https://cloud.ibm.com/docs/apis/vpc-metadata).

See also the tutorial [Onboarding a virtual server image for VPC](https://cloud.ibm.com/docs/account?topic=account-catalog-vsivpc-tutorial&format=markdown) and the [Import offering](https://cloud.ibm.com/docs/apis/resource-catalog/private-catalog#import-offering){: external} method in the Catalog Management API.