About cookies on this site Our websites require some cookies to function properly (required). In addition, other cookies may be used with your consent to analyze site usage, improve the user experience and for advertising. For more information, please review your options. By visiting our website, you agree to our processing of information as described in IBM’sprivacy statement. To provide a smooth navigation, your cookie preferences will be shared across the IBM web domains listed here.
Introduction
Last updated: 2025-07-15
This reference includes the full IBM Cloud® Virtual Private Cloud (VPC) Metadata API, as well as newly released open beta features. This reference may also include limited beta features for customer accounts with special approval to preview those features.
There are no backward-compatibility guarantees as a feature progresses through its beta phase, or from the final beta release to its initial GA release. Using features that are not GA mature could introduce the risk of corrupting resources in your account.
Access tokens and Certificates methods are no longer in this API reference. Those methods are now documeted in the Beta VPC Identity API.
Read the introduction in the generally available VPC Metadata API for details on endpoint URLs, auditing, error handling, versioning, and other important information.
Versioning
API requests require a major version in the path (/v1/
) and a date-based version as a query
parameter in the format version=YYYY-MM-DD
.
This reference documents API behavior for any date value in the version
parameter within 45 days
of today’s date. To view the reference for any other supported versions of the API, select it from
the Version list. See also Versioning in the VPC API.
Maturity query parameter
API requests accept a maturity
query parameter. This parameter lets you decide on the level of
stability to use before features become generally available.
API requests must specify a maturity=beta
query parameter. Omitting maturity
results in the GA
version of the API being used, which can result in different behavior.
Example of using the maturity
parameter in a request:
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance?maturity=beta" -H "Authorization: Bearer $iam_token"
Authentication
To start an authenticated session, create an identity access token. You can later generate an IAM access token by using an identity token and then use that token to access IAM-enabled services. For more information, see Configure the metadata service and the examples on this page.
A session lasts for the lifetime of the token, during which the metadata service can be called. You can reuse a single access token for multiple metadata API calls, as long as the token has not expired.
The examples use jq
as a parser, a third-party tool licensed under the MIT
license. jq
may not come preinstalled on all VPC images
available when creating an instance. You might need to install jq
prior to use or use any parser
of your choice.
Consider storing the metadata endpoint in a variable. Use the example on this page or see Configure the metadata service for more information.
This example extracts the access token value and places it in the identity_token
environment
variable.
identity_token=`curl -X PUT "$vpc_metadata_api_endpoint/identity/v1/token?version=2025-07-15" -H "Metadata-Flavor: ibm" -H "Accept: application/json" -d '{ "expires_in": 300 }' | jq -r '(.access_token)'`
Example response from the previous request:
{
"access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IlZTSS1DUl91cy1lYXN0X2I5MmI0YzAxNWJhOTc4NzgiLCJ....",
"created_at": "2024-06-24T11:08:39.363Z",
"expires_at": "2024-06-24T11:13:39.363Z",
"expires_in": 300
}
Pass the access token in the Authorization
header to authenticate metadata requests. Tokens
authenticate requests without embedding service credentials in every call. See the methods in the
API specification for examples using $identity_token
.
This example uses the identity_token
environment variable from the previous example to create an
IAM token associated with the specified trusted profile ID. Upon success, provide the iam_token
environment variable when calling any IAM-enabled IBM service to perform operations using the
authorizations granted to that trusted profile. Learn more about Creating trusted
profiles.
iam_token=`curl -X POST "$vpc_metadata_api_endpoint/identity/v1/iam_token?version=2025-07-15" -H "Authorization: Bearer $identity_token" -d '{
"trusted_profile": {
"id": "Profile-8dd84246-7df4-4667-94e4-8cede51d5ac5"
}
}' | jq -r '(.access_token)'`
This example shows how to use the HTTPS protocol to retrieve instance initialization metadata. For
this example, the service must be configured with the metadata_service.protocol
property set to
https
.
user_data=`curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance/initialization?version=2025-07-15" -H "Accept: application/json" -H "Authorization: Bearer $identity_token"
| jq -r '(.user_data)'`
Change log
Important changes to the beta metadata API, such as additions, updates, and deprecations, are documented in the Beta VPC Metadata API change log.
Methods
Retrieve the instance
This requests retrieves information for the calling instance.
GET /metadata/v1/instance
Request
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
The availability policy for this virtual server instance
- availability_policy
The action to perform if the compute host experiences a failure:
restart
: Automatically restart the virtual server instance after host failurestop
: Leave the virtual server instance stopped after host failure
The enumerated values for this property may expand in the future.
Possible values: [
restart
,stop
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The total bandwidth (in megabits per second) shared across the instance network attachments or instance network interfaces and storage volumes of the virtual server instance
Example:
1000
The boot volume attachment for this virtual server instance
Examples:{ "device": { "id": "0717-80b3e36e-41f4-40e9-bd56-beae81792a68-679qb" }, "id": "0717-82cbf856-9cbb-45fb-b62f-d7bcef32399a", "name": "my-volume-attachment", "volume": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "id": "r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "name": "my-volume", "resource_type": "volume" } }
- boot_volume_attachment
The unique identifier for this volume attachment
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-82cbf856-9cbb-45fb-b62f-d7bcef32399a
The name for this volume attachment. The name is unique across all volume attachments on the instance.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-volume-attachment
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The configuration for the volume as a device in the instance operating system.
This property may be absent if the volume attachment's
status
is notattached
.Examples:{ "id": "0717-80b3e36e-41f4-40e9-bd56-beae81792a68-679qb" }
- device
A unique identifier for the device which is exposed to the instance operating system
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
The attached volume.
This property will be absent if the volume has not yet been provisioned.
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "id": "r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "name": "my-volume", "resource_type": "volume" }
- volume
The CRN for this volume
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5
The unique identifier for this volume
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5
The name for this volume. The name is unique across all volumes in the region.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-volume
The resource type
Possible values: [
volume
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The cluster network attachments for this virtual server instance.
The cluster network attachments are ordered for consistent instance configuration.
Possible values: 0 ≤ number of items ≤ 128, contains only unique items
The confidential compute mode for this virtual server instance.
Possible values: [
disabled
,sgx
,tdx
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The date and time that the virtual server instance was created
Possible values: 10 ≤ length ≤ 64, Value must match regular expression
^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[\+-]\d{2}:\d{2})?)$
The CRN for this virtual server instance
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::instance:0717_e21b7391-2ca2-4ab5-84a8-b92157a633b0
The instance disks for this virtual server instance.
Possible values: number of items ≥ 0
Indicates whether secure boot is enabled for this virtual server instance.
The reasons for the current
health_state
(if any).Possible values: number of items ≥ 0
The health of this resource:
ok
: No abnormal behavior detecteddegraded
: Experiencing compromised performance, capacity, or connectivityfaulted
: Completely unreachable, inoperative, or otherwise entirely incapacitatedinapplicable
: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state offailed
ordeleting
will have a health state ofinapplicable
. Apending
resource may also have this state.
Possible values: [
degraded
,faulted
,inapplicable
,ok
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Example:
ok
The unique identifier for this virtual server instance
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717_e21b7391-2ca2-4ab5-84a8-b92157a633b0
The reasons for the current
lifecycle_state
(if any).Possible values: number of items ≥ 0
The lifecycle state of the virtual server instance.
Possible values: [
deleting
,failed
,pending
,stable
,suspended
,updating
,waiting
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Example:
stable
The amount of memory, truncated to whole gibibytes.
The maximum limit for this property may expand in the future.
Possible values: 1 ≤ value ≤ 256000
Example:
64
The metadata service configuration
The name for this virtual server instance. The name is unique across all virtual server instances in the region.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-instance
The network attachments for this virtual server instance, including the primary network attachment.
Possible values: number of items ≥ 0, contains only unique items
The network interfaces for this instance, including the primary network interface.
If this instance has network attachments, each network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface.
Possible values: number of items ≥ 1, contains only unique items
The number of NUMA nodes this virtual server instance is provisioned on.
Possible values: value ≥ 1
Example:
2
The primary network interface for this virtual server instance.
If this instance has network attachments, this primary network interface is a read-only representation of the primary network attachment and its attached virtual network interface.
Examples:{ "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-interface", "primary_ipv4_address": "10.0.1.5", "resource_type": "network_interface", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" } }
- primary_network_interface
The unique identifier for this instance network interface.
If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and the identifier is that of the corresponding network attachment.
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-d54eb633-98ea-459d-aa00-6a8e780175a7
The name for this instance network interface.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-instance-network-interface
The primary IPv4 address.
If the address has not yet been selected, the value will be
0.0.0.0
.Possible values: 7 ≤ length ≤ 15, Value must match regular expression
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Example:
192.168.3.4
The resource type
Possible values: [
network_interface
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The associated subnet
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }
- subnet
The CRN for this subnet
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e
The unique identifier for this subnet
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e
The name for this subnet. The name is unique across all subnets in the VPC.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-subnet
The resource type
Possible values: [
subnet
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The profile for this virtual server instance
Examples:{ "name": "bx2-4x16", "resource_type": "instance_profile" }
- profile
The globally unique name for this virtual server instance profile
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
bx2-4x16
The resource type
Possible values: [
instance_profile
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The resource group for this instance
Examples:{ "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }
- resource_group
The unique identifier for this resource group
Possible values: length = 32, Value must match regular expression
^[0-9a-f]{32}$
Example:
fee82deba12e4c0fb69c3b09d1f12345
The name for this resource group
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
^[a-zA-Z0-9-_ ]+$
Example:
my-resource-group
The resource type
Possible values: [
instance
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Indicates whether the state of the virtual server instance permits a start request.
The status of the virtual server instance.
The enumerated values for this property may expand in the future.
Possible values: [
deleting
,failed
,pending
,restarting
,running
,starting
,stopped
,stopping
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The reasons for the current status (if any).
Possible values: number of items ≥ 0
The amount of bandwidth (in megabits per second) allocated exclusively to instance network attachments or instance network interfaces.
Example:
500
The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes. An increase in this value will result in a corresponding decrease to
total_network_bandwidth
.Example:
500
The virtual server instance VCPU configuration
Examples:{ "architecture": "amd64", "count": 56, "manufacturer": "intel" }
The volume attachments for this virtual server instance, including the boot volume attachment.
Possible values: number of items ≥ 1, contains only unique items
The VPC this virtual server instance resides in
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "id": "r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "name": "my-vpc", "resource_type": "vpc" }
- vpc
The CRN for this VPC
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b
The unique identifier for this VPC
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
r006-4727d842-f94f-4a2d-824a-9bc9b02c523b
The name for this VPC. The name is unique across all VPCs in the region.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-vpc
The resource type
Possible values: [
vpc
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The zone this virtual server instance resides in
Examples:{ "name": "us-south-1" }
- zone
The globally unique name for this zone
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
us-south-1
If present, this virtual server instance was provisioned from a catalog.
- catalog_offering
The catalog offering version this virtual server instance was provisioned from.
The catalog offering version is not managed by the IBM VPC service, and may no longer exist, or may refer to a different image CRN than the
image.crn
for this virtual server instance. However, all images associated with a catalog offering version will have the same checksum, and therefore will have the same data.- version
The CRN for this version of a catalog offering
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:globalcatalog-collection:global:a/aa2432b1fa4d4ace891e9b80fc104e34:1082e7d2-5e2f-0a11-a3bc-f88a8e1931fc:version:00111601-0ec5-41ac-b142-96d1e64e6442/ec66bec2-6a33-42d6-9323-26dd4dc8875d
The billing plan used for the catalog offering version.
If absent, no billing plan is in use (free).
- plan
The CRN for this catalog offering version's billing plan
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:globalcatalog-collection:global:a/aa2432b1fa4d4ace891e9b80fc104e34:51c9e0db-2911-45a6-adb0-ac5332d27cf2:plan:sw.51c9e0db-2911-45a6-adb0-ac5332d27cf2.772c0dbe-aa62-482e-adbe-a3fc20101e0e
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
If present, the cluster network that this virtual server instance resides in
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::cluster-network:0717-da0df18c-7598-4633-a648-fdaac28a5573", "id": "0717-da0df18c-7598-4633-a648-fdaac28a5573", "name": "my-cluster-network", "resource_type": "cluster_network" }
- cluster_network
The CRN for this cluster network
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::cluster-network:0717-da0df18c-7598-4633-a648-fdaac28a5573
The unique identifier for this cluster network
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-da0df18c-7598-4633-a648-fdaac28a5573
The name for this cluster network. The name must not be used by another cluster network in the region.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-cluster-network
The resource type
Possible values: [
cluster_network
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
If present, the dedicated host this virtual server instance has been placed on.
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::dedicated-host:0717-1e09281b-f177-46fb-baf1-bc152b2e391a", "id": "0717-1e09281b-f177-46fb-baf1-bc152b2e391a", "name": "my-dedicated-host", "resource_type": "dedicated_host" }
- dedicated_host
The CRN for this dedicated host
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::dedicated-host:0717-1e09281b-f177-46fb-baf1-bc152b2e391a
The unique identifier for this dedicated host
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-1e09281b-f177-46fb-baf1-bc152b2e391a
The name for this dedicated host. The name is unique across all dedicated hosts in the region.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-host
The resource type
Possible values: [
dedicated_host
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The virtual server instance GPU configuration
The image the virtual server instance was provisioned from
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::image:r006-72b27b5c-f4b0-48bb-b954-5becc7c1dcb8", "id": "r006-72b27b5c-f4b0-48bb-b954-5becc7c1dcb8", "name": "my-image", "resource_type": "image" }
- image
The CRN for this image
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::image:r006-72b27b5c-f4b0-48bb-b954-5becc7c1dcb8
The unique identifier for this image
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
r006-72b27b5c-f4b0-48bb-b954-5becc7c1dcb8
The name for this image. The name is unique across all images in the region.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-image
The resource type
Possible values: [
image
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
If present, this property indicates that the resource associated with this reference is remote and therefore may not be directly retrievable.
The placement restrictions for the virtual server instance
The primary network attachment for this virtual server instance
Examples:{ "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-attachment", "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "resource_type": "instance_network_attachment", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "virtual_network_interface": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "name": "my-virtual-network-interface", "resource_type": "virtual_network_interface" } }
- primary_network_attachment
The unique identifier for this instance network attachment
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-d54eb633-98ea-459d-aa00-6a8e780175a7
The name for this instance network attachment. The name is unique across all network attachments for the instance.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-instance-network-attachment
The primary IP address of the virtual network interface for the instance network attachment
Examples:{ "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }
- primary_ip
The IP address.
If the address has not yet been selected, the value will be
0.0.0.0
.This property may expand to support IPv6 addresses in the future.
Possible values: 7 ≤ length ≤ 15, Value must match regular expression
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Example:
192.168.3.4
The unique identifier for this reserved IP
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb
The name for this reserved IP. The name is unique across all reserved IPs in a subnet.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-reserved-ip
The resource type
Possible values: [
subnet_reserved_ip
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The resource type
Possible values: [
instance_network_attachment
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The subnet of the virtual network interface for the instance network attachment
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }
- subnet
The CRN for this subnet
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e
The unique identifier for this subnet
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e
The name for this subnet. The name is unique across all subnets in the VPC.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-subnet
The resource type
Possible values: [
subnet
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The virtual network interface for this instance network attachment
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "name": "my-virtual-network-interface", "resource_type": "virtual_network_interface" }
- virtual_network_interface
The CRN for this virtual network interface
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef
The unique identifier for this virtual network interface
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-54eb57ee-86f2-4796-90bb-d7874e0831ef
The name for this virtual network interface. The name is unique across all virtual network interfaces in the VPC.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-virtual-network-interface
The resource type
Possible values: [
virtual_network_interface
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The reservation used by this virtual server instance.
If absent, no reservation is in use.
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::reservation:0717-ba49df72-37b8-43ac-98da-f8e029de0e63", "id": "0717-ba49df72-37b8-43ac-98da-f8e029de0e63", "name": "my-reservation", "resource_type": "reservation" }
- reservation
The CRN for this reservation
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::reservation:0717-ba49df72-37b8-43ac-98da-f8e029de0e63
The unique identifier for this reservation
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-ba49df72-37b8-43ac-98da-f8e029de0e63
The name for this reservation. The name is unique across all reservations in the region.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-reservation
The resource type
Possible values: [
reservation
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
Status Code
The instance was retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
Example responses
{ "availability_policy": { "host_failure": "restart" }, "bandwidth": 4000, "boot_volume_attachment": { "device": { "id": "0717-80b3e36e-41f4-40e9-bd56-beae81792a68-679qb" }, "id": "0717-82cbf856-9cbb-45fb-b62f-d7bcef32399a", "name": "my-volume-attachment", "volume": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "id": "r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "name": "my-volume", "resource_type": "volume" } }, "cluster_network_attachments": [], "confidential_compute_mode": "sgx", "created_at": "2020-03-26T16:11:57Z", "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::instance:0717_e21b7391-2ca2-4ab5-84a8-b92157a633b0", "dedicated_host": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::dedicated-host:0717-1e09281b-f177-46fb-baf1-bc152b2e391a", "id": "0717-1e09281b-f177-46fb-baf1-bc152b2e391a", "name": "my-dedicated-host", "resource_type": "dedicated_host" }, "disks": [], "enable_secure_boot": true, "health_reasons": [], "health_state": "ok", "id": "0717_e21b7391-2ca2-4ab5-84a8-b92157a633b0", "image": { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::image:r006-72b27b5c-f4b0-48bb-b954-5becc7c1dcb8", "id": "r006-72b27b5c-f4b0-48bb-b954-5becc7c1dcb8", "name": "my-image", "resource_type": "image" }, "lifecycle_reasons": [], "lifecycle_state": "stable", "memory": 8, "metadata_service": { "enabled": true, "protocol": "http", "response_hop_limit": 1 }, "name": "my-instance", "network_attachments": [ { "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-attachment", "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "resource_type": "instance_network_attachment", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "virtual_network_interface": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "name": "my-virtual-network-interface", "resource_type": "virtual_network_interface" } } ], "network_interfaces": [ { "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-interface", "primary_ipv4_address": "10.0.1.5", "resource_type": "network_interface", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" } } ], "numa_count": 2, "placement_target": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::dedicated-host:0717-1e09281b-f177-46fb-baf1-bc152b2e391a", "id": "0717-1e09281b-f177-46fb-baf1-bc152b2e391a", "name": "my-dedicated-host", "resource_type": "dedicated_host" }, "primary_network_attachment": { "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-attachment", "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "resource_type": "instance_network_attachment", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "virtual_network_interface": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "name": "my-virtual-network-interface", "resource_type": "virtual_network_interface" } }, "primary_network_interface": { "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-interface", "primary_ipv4_address": "10.0.1.5", "resource_type": "network_interface", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" } }, "profile": { "name": "bx2-4x16", "resource_type": "instance_profile" }, "reservation_affinity": { "policy": "disabled", "pool": [] }, "resource_group": { "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }, "resource_type": "instance", "startable": true, "status": "running", "status_reasons": [], "total_network_bandwidth": 3000, "total_volume_bandwidth": 1000, "vcpu": { "architecture": "amd64", "count": 56, "manufacturer": "intel" }, "volume_attachments": [ { "device": { "id": "0717-80b3e36e-41f4-40e9-bd56-beae81792a68-679qb" }, "id": "0717-82cbf856-9cbb-45fb-b62f-d7bcef32399a", "name": "my-volume-attachment", "volume": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "id": "r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "name": "my-volume", "resource_type": "volume" } }, { "device": { "id": "0717-e77125cb-4df0-4988-a878-531ae0ae0b70-w8mw8" }, "id": "0717-e77125cb-4df0-4988-a878-531ae0ae0b70", "name": "my-volume-attachment-2", "volume": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-2cc091f5-4d46-48f3-99b7-3527ae3f4392", "id": "r006-2cc091f5-4d46-48f3-99b7-3527ae3f4392", "name": "my-volume-2", "resource_type": "volume" } } ], "vpc": { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "id": "r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "name": "my-vpc", "resource_type": "vpc" }, "zone": { "name": "us-south-1" } }
List cluster network attachments
This request lists cluster network attachments for the calling instance.
GET /metadata/v1/instance/cluster_network_attachments
Request
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
A server-provided token determining what resource to start the page on
Possible values: 1 ≤ length ≤ 4096, Value must match regular expression
^[ -~]+$
The number of resources to return on a page
Possible values: 1 ≤ value ≤ 100
Default:
50
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance/cluster_network_attachments?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
A page of ordered cluster network attachments (sorted based on the
before
property) for the instance. A cluster network attachment represents a device to which a cluster network interface is attached.A link to the first page of resources
Examples:{ "href": "https://api.metadata.cloud.ibm.com/metadata/v1/instance/cluster_network_attachments?limit=20" }
- first
The URL for a page of resources
Possible values: Value must match regular expression
^http(s)?:\/\/([^\/?#]*)([^?#]*)(\?([^#]*))?(#(.*))?$
The maximum number of resources that can be returned by the request
Possible values: 1 ≤ value ≤ 100
Example:
20
The total number of resources across all pages
Possible values: value ≥ 0
Example:
132
A link to the next page of resources. This property is present for all pages except the last page
Examples:{ "href": "https://api.metadata.cloud.ibm.com/metadata/v1/instance/cluster_network_attachments?start=0717-fb880975-db45-4459-8548-64e3995ac213&limit=20" }
- next
The URL for a page of resources
Possible values: Value must match regular expression
^http(s)?:\/\/([^\/?#]*)([^?#]*)(\?([^#]*))?(#(.*))?$
Status Code
The instance cluster network attachments were retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
Example responses
{ "cluster_network_attachments": [ { "before": { "id": "0717-a69563fa-0415-4d6e-aeb3-a3f14654bf90", "name": "other-instance-cluster-network-attachment", "resource_type": "instance_cluster_network_attachment" }, "cluster_network_interface": { "id": "0717-ffc092f7-5d02-4b93-ab69-26860529b9fb", "name": "my-cluster-network-interface", "primary_ip": { "address": "10.1.0.6", "id": "0717-d4d6489a-3bf5-4104-a33a-3572faf2d117", "name": "my-cluster-network-subnet-reserved-ip", "resource_type": "cluster_network_subnet_reserved_ip" }, "resource_type": "cluster_network_interface", "subnet": { "id": "0717-7931845c-65c4-4b0a-80cd-7d9c1a6d7930", "name": "my-cluster-network-subnet", "resource_type": "cluster_network_subnet" } }, "id": "0717-fb880975-db45-4459-8548-64e3995ac213", "lifecycle_reasons": [], "lifecycle_state": "stable", "name": "my-instance-cluster-network-attachment", "resource_type": "instance_cluster_network_attachment" } ], "first": { "href": "https://api.metadata.cloud.ibm.com/metadata/v1/instance/cluster_network_attachments?limit=20" }, "limit": 20, "total_count": 1 }
Retrieve a cluster network attachment
This request retrieves a cluster network attachment for the calling instance.
GET /metadata/v1/instance/cluster_network_attachments/{id}
Request
Path Parameters
The instance cluster network attachment identifier
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance/cluster_network_attachments/$id?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
The cluster network interface for this instance cluster network attachment
Examples:{ "id": "0717-ffc092f7-5d02-4b93-ab69-26860529b9fb", "name": "my-cluster-network-interface", "primary_ip": { "address": "10.1.0.6", "id": "0717-d4d6489a-3bf5-4104-a33a-3572faf2d117", "name": "my-cluster-network-subnet-reserved-ip", "resource_type": "cluster_network_subnet_reserved_ip" }, "resource_type": "cluster_network_interface", "subnet": { "id": "0717-7931845c-65c4-4b0a-80cd-7d9c1a6d7930", "name": "my-cluster-network-subnet", "resource_type": "cluster_network_subnet" } }
- cluster_network_interface
The unique identifier for this cluster network interface
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-ffc092f7-5d02-4b93-ab69-26860529b9fb
The name for this cluster network interface. The name is unique across all interfaces in the cluster network.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-cluster-network-interface
The primary IP for this cluster network interface
Examples:{ "address": "10.1.0.6", "id": "0717-d4d6489a-3bf5-4104-a33a-3572faf2d117", "name": "my-cluster-network-subnet-reserved-ip", "resource_type": "cluster_network_subnet_reserved_ip" }
- primary_ip
The IP address.
If the address is pending allocation, the value will be
0.0.0.0
.This property may expand to support IPv6 addresses in the future.
Possible values: 7 ≤ length ≤ 15, Value must match regular expression
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Example:
10.1.0.6
The unique identifier for this cluster network subnet reserved IP
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-d4d6489a-3bf5-4104-a33a-3572faf2d117
The name for this cluster network subnet reserved IP. The name is unique across all reserved IPs in a cluster network subnet.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-cluster-network-subnet-reserved-ip
The resource type
Possible values: [
cluster_network_subnet_reserved_ip
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The resource type
Possible values: [
cluster_network_interface
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
- Examples:
{ "id": "0717-7931845c-65c4-4b0a-80cd-7d9c1a6d7930", "name": "my-cluster-network-subnet", "resource_type": "cluster_network_subnet" }
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The unique identifier for this instance cluster network attachment
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-fb880975-db45-4459-8548-64e3995ac213
The reasons for the current
lifecycle_state
(if any).Possible values: number of items ≥ 0
The lifecycle state of the instance cluster network attachment
Possible values: [
deleting
,failed
,pending
,stable
,suspended
,updating
,waiting
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Example:
stable
The name for this instance cluster network attachment. The name is unique across all network attachments for the instance.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-instance-network-attachment
The resource type
Possible values: [
instance_cluster_network_attachment
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The instance cluster network attachment that is immediately before. If absent, this is the last instance cluster network attachment.
Examples:{ "cluster_network_interface": { "id": "0717-ffc092f7-5d02-4b93-ab69-26860529b9fb", "name": "my-cluster-network-interface", "primary_ip": { "address": "10.1.0.6", "id": "0717-d4d6489a-3bf5-4104-a33a-3572faf2d117", "name": "my-cluster-network-subnet-reserved-ip", "resource_type": "cluster_network_subnet_reserved_ip" }, "resource_type": "cluster_network_interface", "subnet": { "id": "0717-7931845c-65c4-4b0a-80cd-7d9c1a6d7930", "name": "my-cluster-network-subnet", "resource_type": "cluster_network_subnet" } }, "id": "0717-a69563fa-0415-4d6e-aeb3-a3f14654bf90", "name": "other-instance-cluster-network-attachment", "resource_type": "instance_cluster_network_attachment" }
Status Code
The instance cluster network attachment was retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
A cluster network attachment with the specified identifier could not be found or is not associated with the calling instance
Example responses
{ "before": { "id": "0717-a69563fa-0415-4d6e-aeb3-a3f14654bf90", "name": "other-instance-cluster-network-attachment", "resource_type": "instance_cluster_network_attachment" }, "cluster_network_interface": { "id": "0717-ffc092f7-5d02-4b93-ab69-26860529b9fb", "name": "my-cluster-network-interface", "primary_ip": { "address": "10.1.0.6", "id": "0717-d4d6489a-3bf5-4104-a33a-3572faf2d117", "name": "my-cluster-network-subnet-reserved-ip", "resource_type": "cluster_network_subnet_reserved_ip" }, "resource_type": "cluster_network_interface", "subnet": { "id": "0717-7931845c-65c4-4b0a-80cd-7d9c1a6d7930", "name": "my-cluster-network-subnet", "resource_type": "cluster_network_subnet" } }, "id": "0717-fb880975-db45-4459-8548-64e3995ac213", "lifecycle_reasons": [], "lifecycle_state": "stable", "name": "my-instance-cluster-network-attachment", "resource_type": "instance_cluster_network_attachment" }
Retrieve initialization information
This request retrieves initialization information for the calling instance.
GET /metadata/v1/instance/initialization
Request
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance/initialization?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
The public SSH keys used at instance initialization.
The user data to be made available when setting up the virtual server instance
Possible values: 0 ≤ length ≤ 65535, Value must match regular expression
^[\s\S]*$
The default trusted profile configuration specified at virtual server instance creation. If absent, no default trusted profile was specified.
- default_trusted_profile
If set to
true
, the system created a link to the specifiedtarget
trusted profile during instance creation. Regardless of whether a link was created by the system or manually using the IAM Identity service, it will be automatically deleted when the instance is deleted.Example:
true
The default IAM trusted profile to use for this virtual server instance
Examples:{ "crn": "crn:v1:bluemix:public:iam-identity::a/aa2432b1fa4d4ace891e9b80fc104e34::profile:Profile-9fd84246-7df4-4667-94e4-8ecde51d5ac5", "id": "Profile-9fd84246-7df4-4667-94e4-8ecde51d5ac5", "resource_type": "trusted_profile" }
- target
The CRN for this trusted profile
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:iam-identity::a/aa2432b1fa4d4ace891e9b80fc104e34::profile:Profile-9fd84246-7df4-4667-94e4-8ecde51d5ac5
The unique identifier for this trusted profile
Possible values: 10 ≤ length ≤ 64, Value must match regular expression
^Profile-[-0-9a-z_]+$
Example:
Profile-9fd84246-7df4-4667-94e4-8ecde51d5ac5
The resource type
Possible values: [
trusted_profile
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Status Code
The initialization information was retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
Example responses
{ "default_trusted_profile": { "auto_link": true, "target": { "crn": "crn:v1:bluemix:public:iam-identity::a/aa2432b1fa4d4ace891e9b80fc104e34::profile:Profile-9fd84246-7df4-4667-94e4-8ecde51d5ac5", "id": "Profile-9fd84246-7df4-4667-94e4-8ecde51d5ac5", "resource_type": "trusted_profile" } }, "keys": [ { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::key:r006-82679077-ac3b-4c10-be16-63e9c21f0f45", "fingerprint": "SHA256:RJ+YWs2kupwFGiJuLqY85twmcdLOUcjIc9cA6IR8n8E", "id": "r006-82679077-ac3b-4c10-be16-63e9c21f0f45", "name": "my-key-1" } ], "user_data": "[...]" }
List network attachments
This request lists network attachments for the calling instance.
GET /metadata/v1/instance/network_attachments
Request
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance/network_attachments?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
The network attachments for the instance
Status Code
The instance network attachments were retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
Example responses
{ "network_attachments": [ { "created_at": "2023-09-30T23:42:32.993Z", "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "lifecycle_state": "stable", "name": "my-instance-network-attachment", "port_speed": 1000, "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "resource_type": "instance_network_attachment", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "type": "primary", "virtual_network_interface": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "name": "my-virtual-network-interface", "resource_type": "virtual_network_interface" } }, { "created_at": "2023-09-30T23:42:33.366Z", "id": "0717-822a3789-61d5-4b8e-82c5-4310e6b7dc1b", "lifecycle_state": "stable", "name": "my-instance-network-attachment-2", "port_speed": 1000, "primary_ip": { "address": "10.0.2.10", "id": "0717-948a1ea9-0ffe-4c9e-aa7b-be4dc2d3e749", "name": "my-reserved-ip-z1-2", "resource_type": "subnet_reserved_ip" }, "resource_type": "instance_network_attachment", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-c0461da9-04be-4a26-ac87-94e06c19b840", "id": "0717-c0461da9-04be-4a26-ac87-94e06c19b840", "name": "my-subnet-z1-2", "resource_type": "subnet" }, "type": "secondary", "virtual_network_interface": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-fa41aecb-4f21-423d-8082-630bfba1e1d9", "id": "0717-fa41aecb-4f21-423d-8082-630bfba1e1d9", "name": "my-virtual-network-interface-2", "resource_type": "virtual_network_interface" } } ] }
Retrieve a network attachment
This request retrieves a network attachment for the calling instance.
GET /metadata/v1/instance/network_attachments/{id}
Request
Path Parameters
The instance network attachment identifier
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance/network_attachments/$id?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
The date and time that the instance network attachment was created
Possible values: 10 ≤ length ≤ 64, Value must match regular expression
^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[\+-]\d{2}:\d{2})?)$
The unique identifier for this instance network attachment
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-d54eb633-98ea-459d-aa00-6a8e780175a7
The lifecycle state of the instance network attachment
Possible values: [
deleting
,failed
,pending
,stable
,suspended
,updating
,waiting
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Example:
stable
The name for this instance network attachment. The name is unique across all network attachments for the instance.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-instance-network-attachment
The port speed for this instance network attachment in Mbps
Example:
1000
The primary IP address of the virtual network interface for the instance network attachment
Examples:{ "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }
- primary_ip
The IP address.
If the address has not yet been selected, the value will be
0.0.0.0
.This property may expand to support IPv6 addresses in the future.
Possible values: 7 ≤ length ≤ 15, Value must match regular expression
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Example:
192.168.3.4
The unique identifier for this reserved IP
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb
The name for this reserved IP. The name is unique across all reserved IPs in a subnet.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-reserved-ip
The resource type
Possible values: [
subnet_reserved_ip
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The resource type
Possible values: [
instance_network_attachment
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The subnet of the virtual network interface for the instance network attachment
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }
- subnet
The CRN for this subnet
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e
The unique identifier for this subnet
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e
The name for this subnet. The name is unique across all subnets in the VPC.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-subnet
The resource type
Possible values: [
subnet
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The instance network attachment type
Possible values: [
primary
,secondary
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Example:
primary
The virtual network interface for this instance network attachment
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "name": "my-virtual-network-interface", "resource_type": "virtual_network_interface" }
- virtual_network_interface
The CRN for this virtual network interface
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef
The unique identifier for this virtual network interface
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-54eb57ee-86f2-4796-90bb-d7874e0831ef
The name for this virtual network interface. The name is unique across all virtual network interfaces in the VPC.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-virtual-network-interface
The resource type
Possible values: [
virtual_network_interface
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Status Code
The instance network attachment was retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
A network attachment with the specified identifier could not be found or is not associated with the calling instance
Example responses
{ "created_at": "2023-09-30T23:42:32.993Z", "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "lifecycle_state": "stable", "name": "my-instance-network-attachment", "port_speed": 1000, "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "resource_type": "instance_network_attachment", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "type": "primary", "virtual_network_interface": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "name": "my-virtual-network-interface", "resource_type": "virtual_network_interface" } }
List instance network interfaces
This request lists network interfaces for the calling instance.
GET /metadata/v1/instance/network_interfaces
Request
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance/network_interfaces?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
The network interfaces for the instance
Status Code
The instance network interfaces were retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
Example responses
{ "network_interfaces": [ { "allow_ip_spoofing": false, "created_at": "2024-10-15T03:24:32.993Z", "floating_ips": [ { "address": "203.0.113.1", "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::floating-ip:r006-f45e0d90-12a8-4460-8210-290ff2ab75cd", "id": "r006-f45e0d90-12a8-4460-8210-290ff2ab75cd", "name": "my-floating-ip" } ], "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-interface", "port_speed": 1000, "primary_ipv4_address": "10.0.1.5", "resource_type": "network_interface", "security_groups": [ { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271", "id": "r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271", "name": "my-security-group" } ], "status": "available", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "type": "primary" } ] }
Retrieve an instance network interface
This request retrieves a network interface for the calling instance.
GET /metadata/v1/instance/network_interfaces/{id}
Request
Path Parameters
The instance network interface identifier
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance/network_interfaces/$id?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
Indicates whether source IP spoofing is allowed on this instance network interface.
If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and source IP spoofing is managed on the attached virtual network interface.
Example:
true
The date and time that the instance network interface was created.
If this instance has network attachments, this network interface was created as a read-only representation when its corresponding network attachment was created.
Possible values: 10 ≤ length ≤ 64, Value must match regular expression
^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[\+-]\d{2}:\d{2})?)$
The floating IPs associated with this instance network interface.
If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and the floating IPs are associated with the attached virtual network interface.
The unique identifier for this instance network interface.
If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and the identifier is that of the corresponding network attachment.
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-d54eb633-98ea-459d-aa00-6a8e780175a7
The name for this instance network interface.
If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and the name matches its corresponding network attachment.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-instance-network-interface
The instance network interface port speed in Mbps.
If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and the port speed is that of its corresponding network attachment.
Example:
1000
The primary IPv4 address.
If the address has not yet been selected, the value will be
0.0.0.0
.Possible values: 7 ≤ length ≤ 15, Value must match regular expression
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Example:
192.168.3.4
The resource type
Possible values: [
network_interface
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The security groups targeting this instance network interface.
If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and the security groups are associated with the attached virtual network interface.
Possible values: number of items ≥ 1, contains only unique items
The status of the instance network interface.
If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and the status is computed from them.
Possible values: [
available
,deleting
,failed
,pending
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Example:
available
The associated subnet
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }
- subnet
The CRN for this subnet
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e
The unique identifier for this subnet
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e
The name for this subnet. The name is unique across all subnets in the VPC.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-subnet
The resource type
Possible values: [
subnet
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The instance network interface type.
If this instance has network attachments, this network interface is a read-only representation of its corresponding network attachment and its attached virtual network interface, and the type is that of its corresponding network attachment.
Possible values: [
primary
,secondary
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Example:
primary
Status Code
The instance network interface was retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
An instance network interface with the specified identifier could not be found or is not associated with the calling instance
Example responses
{ "allow_ip_spoofing": false, "created_at": "2024-10-15T03:24:32.993Z", "floating_ips": [ { "address": "203.0.113.1", "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::floating-ip:r006-f45e0d90-12a8-4460-8210-290ff2ab75cd", "id": "r006-f45e0d90-12a8-4460-8210-290ff2ab75cd", "name": "my-floating-ip" } ], "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-interface", "port_speed": 1000, "primary_ipv4_address": "10.0.1.5", "resource_type": "network_interface", "security_groups": [ { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271", "id": "r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271", "name": "my-security-group" } ], "status": "available", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "type": "primary" }
List volume attachments
This request lists volume attachments for the calling instance.
GET /metadata/v1/instance/volume_attachments
Request
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance/volume_attachments?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
The volume attachments for the instance
Status Code
The volume attachments were retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
Example responses
{ "volume_attachments": [ { "bandwidth": 250, "created_at": "2024-10-24T16:32:05.000Z", "delete_volume_on_instance_delete": true, "device": { "id": "0717-82cbf856-9cbb-45fb-b62f-d7bcef32399a-w8mw8" }, "id": "0717-fdb3642d-c849-4c29-97a9-03b868616f88", "name": "my-boot-volume-attachment", "status": "attached", "type": "boot", "volume": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-89b05e9a-e635-9464-9747-7ae3f9b03303", "id": "r006-89b05e9a-e635-9464-9747-7ae3f9b03303", "name": "my-boot-volume", "resource_type": "volume" } }, { "bandwidth": 250, "created_at": "2019-03-15T11:44:07.000Z", "delete_volume_on_instance_delete": false, "id": "0717-82cbf856-9cbb-45fb-b62f-d7bcef32399a", "name": "my-data-volume-attachment", "status": "attached", "type": "data", "volume": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "id": "r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "name": "my-volume", "resource_type": "volume" } } ] }
Retrieve a volume attachment
This request retrieves a volume attachment for the calling instance.
GET /metadata/v1/instance/volume_attachments/{id}
Request
Path Parameters
The volume attachment identifier
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/instance/volume_attachments/$id?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
The maximum bandwidth (in megabits per second) for the volume when attached to this instance. This may be lower than the volume bandwidth depending on the configuration of the instance.
Example:
250
The date and time that the volume was attached
Possible values: 10 ≤ length ≤ 64, Value must match regular expression
^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[\+-]\d{2}:\d{2})?)$
Indicates whether deleting the instance will also delete the attached volume
The unique identifier for this volume attachment
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-82cbf856-9cbb-45fb-b62f-d7bcef32399a
The name for this volume attachment. The name is unique across all volume attachments on the instance.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-volume-attachment
The status of this volume attachment.
The enumerated values for this property may expand in the future.
Possible values: [
attached
,attaching
,deleting
,detaching
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The type of volume attachment.
The enumerated values for this property may expand in the future.
Possible values: [
boot
,data
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The configuration for the volume as a device in the instance operating system.
This property may be absent if the volume attachment's
status
is notattached
.Examples:{ "id": "0717-80b3e36e-41f4-40e9-bd56-beae81792a68-679qb" }
- device
A unique identifier for the device which is exposed to the instance operating system
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
The attached volume.
This property will be absent if the volume has not yet been provisioned.
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "id": "r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "name": "my-volume", "resource_type": "volume" }
- volume
The CRN for this volume
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5
The unique identifier for this volume
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5
The name for this volume. The name is unique across all volumes in the region.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-volume
The resource type
Possible values: [
volume
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
Status Code
The volume attachment was retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
A volume attachment with the specified identifier could not be found or is not associated with the calling instance
Example responses
{ "bandwidth": 250, "created_at": "2019-03-15T11:44:07.000Z", "delete_volume_on_instance_delete": false, "id": "0717-82cbf856-9cbb-45fb-b62f-d7bcef32399a", "name": "my-data-volume-attachment", "status": "attached", "type": "data", "volume": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "id": "r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5", "name": "my-volume", "resource_type": "volume" } }
Request
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/keys?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
A page of keys
Status Code
The keys were retrieved successfully
Example responses
{ "keys": [ { "created_at": "2019-01-29T03:48:11.000Z", "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::key:r006-82679077-ac3b-4c10-be16-63e9c21f0f45", "fingerprint": "SHA256:RJ+YWs2kupwFGiJuLqY85twmcdLOUcjIc9cA6IR8n8E", "id": "r006-82679077-ac3b-4c10-be16-63e9c21f0f45", "length": 2048, "name": "my-key-1", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDDGe50Bxa5T5NDddrrtbx2Y4/VGbiCgXqnBsYToIUKoFSHTQl5IX3PasGnneKanhcLwWz5M5MoCRvhxTp66NKzIfAz7r+FX9rxgR+ZgcM253YAqOVeIpOU408simDZKriTlN8kYsXL7P34tsWuAJf4MgZtJAQxous/2byetpdCv8ddnT4X3ltOg9w+LqSCPYfNivqH00Eh7S1Ldz7I8aw5WOp5a+sQFP/RbwfpwHp+ny7DfeIOokcuI42tJkoBn7UsLTVpCSmXr2EDRlSWe/1M/iHNRBzaT3CK0+SwZWd2AEjePxSnWKNGIEUJDlUYp7hKhiQcgT5ZAnWU121oc5En", "resource_group": { "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }, "type": "rsa" }, { "created_at": "2024-10-01T21:46:21.000Z", "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::key:r006-a9f3ae27-4769-43e3-b5a3-a2856fbad468", "fingerprint": "SHA256:XgUFJWiZbPehNHl706+mJbZdPDmSJh8G2ycvCYR2t5U", "id": "r006-a9f3ae27-4769-43e3-b5a3-a2856fbad468", "length": 2048, "name": "my-key-2", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC6iw94c1htpVzC33sd874W6SeTZ9pGDZdY50vsnPUpYVfuU9WDscyy/NYVR74ZvSw1vN1QK57GEW46Uhh2JdvyQ1jiMPI6amu6bHiBqnWTo3HUFPBoxM9/3j0MhspjGyrO7JK3fOwyGrnquAqRq5BPibN8JLuZwCfVyucz98hEmnf9sEphJ5ab3ywVU3echaJZBEdUNEf2ZAHGGe5qnVW33y4PmRf5q90mPkJYwjTgTjZ3fPG2lV01S3eTbHV7zr1wxW4FSTFm7dVnfTURPzKc7mL4MS35s9gX73imvZL6O9ZH54IDoB8TBhx0U5657n6MoznFeXVcFSDLLpMXf7Gr", "resource_group": { "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }, "type": "rsa" } ] }
Request
Path Parameters
The key identifier
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/keys/$id?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
The date and time that the key was created
Possible values: 10 ≤ length ≤ 64, Value must match regular expression
^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[\+-]\d{2}:\d{2})?)$
The CRN for this key
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::key:r006-82679077-ac3b-4c10-be16-63e9c21f0f45
The fingerprint for this key. The value is returned base64-encoded and prefixed with the hash algorithm (such as
SHA256
).The length of this property may expand in the future.
Possible values: 6 ≤ length ≤ 71, Value must match regular expression
^[ -~]*$
Example:
SHA256:yxavE4CIOL2NlsqcurRO3xGjkP6m/0mp8ugojH5yxlY
The unique identifier for this key
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
r006-82679077-ac3b-4c10-be16-63e9c21f0f45
The length of this key (in bits)
Possible values: [
2048
,256
,4096
]The name for this key. The name must not be used by another key in the region. If unspecified, the name will be a hyphenated list of randomly-selected words.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-z]|[a-z][-a-z0-9]*[a-z0-9])$
Example:
my-key-1
The public SSH key, consisting of two space-separated fields: the algorithm name, and the base64-encoded key.
Possible values: 4 ≤ length ≤ 8192, Value must match regular expression
^[ -~]*$
Example:
ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDDGe50Bxa5T5NDddrrtbx2Y4/VGbiCgXqnBsYToIUKoFSHTQl5IX3PasGnneKanhcLwWz5M5MoCRvhxTp66NKzIfAz7r+FX9rxgR+ZgcM253YAqOVeIpOU408simDZKriTlN8kYsXL7P34tsWuAJf4MgZtJAQxous/2byetpdCv8ddnT4X3ltOg9w+LqSCPYfNivqH00Eh7S1Ldz7I8aw5WOp5a+sQFP/RbwfpwHp+ny7DfeIOokcuI42tJkoBn7UsLTVpCSmXr2EDRlSWe/1M/iHNRBzaT3CK0+SwZWd2AEjePxSnWKNGIEUJDlUYp7hKhiQcgT5ZAnWU121oc5En
The resource group for this key
Examples:{ "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }
- resource_group
The unique identifier for this resource group
Possible values: length = 32, Value must match regular expression
^[0-9a-f]{32}$
Example:
fee82deba12e4c0fb69c3b09d1f12345
The name for this resource group
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
^[a-zA-Z0-9-_ ]+$
Example:
my-resource-group
The crypto-system for this key.
The enumerated values for this property may expand in the future.
Possible values: [
ed25519
,rsa
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Status Code
The key was retrieved successfully
A key with the specified identifier could not be found or is not associated with the calling instance
Example responses
{ "created_at": "2019-01-29T03:48:11.000Z", "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::key:r006-82679077-ac3b-4c10-be16-63e9c21f0f45", "fingerprint": "SHA256:RJ+YWs2kupwFGiJuLqY85twmcdLOUcjIc9cA6IR8n8E", "id": "r006-82679077-ac3b-4c10-be16-63e9c21f0f45", "length": 2048, "name": "my-key-1", "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDDGe50Bxa5T5NDddrrtbx2Y4/VGbiCgXqnBsYToIUKoFSHTQl5IX3PasGnneKanhcLwWz5M5MoCRvhxTp66NKzIfAz7r+FX9rxgR+ZgcM253YAqOVeIpOU408simDZKriTlN8kYsXL7P34tsWuAJf4MgZtJAQxous/2byetpdCv8ddnT4X3ltOg9w+LqSCPYfNivqH00Eh7S1Ldz7I8aw5WOp5a+sQFP/RbwfpwHp+ny7DfeIOokcuI42tJkoBn7UsLTVpCSmXr2EDRlSWe/1M/iHNRBzaT3CK0+SwZWd2AEjePxSnWKNGIEUJDlUYp7hKhiQcgT5ZAnWU121oc5En", "resource_group": { "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }, "type": "rsa" }
Request
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/placement_groups?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
A page of placement groups
Status Code
The placement groups were retrieved successfully
Example responses
{ "placement_groups": [ { "created_at": "2020-12-29T19:55:00.000Z", "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::placement-group:r006-418fe842-a3e9-47b9-a938-1aa5bd632871", "id": "r006-418fe842-a3e9-47b9-a938-1aa5bd632871", "lifecycle_state": "stable", "name": "my-placement-group", "resource_group": { "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }, "resource_type": "placement_group", "strategy": "host_spread" } ] }
Retrieve a placement group
This request retrieves a single placement group specified by identifier in the URL.
GET /metadata/v1/placement_groups/{id}
Request
Path Parameters
The placement group identifier
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/placement_groups/$id?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
The date and time that the placement group was created
Possible values: 10 ≤ length ≤ 64, Value must match regular expression
^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[\+-]\d{2}:\d{2})?)$
The CRN for this placement group
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::placement-group:r006-418fe842-a3e9-47b9-a938-1aa5bd632871
The unique identifier for this placement group
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
r006-418fe842-a3e9-47b9-a938-1aa5bd632871
The lifecycle state of the placement group
Possible values: [
deleting
,failed
,pending
,stable
,suspended
,updating
,waiting
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Example:
stable
The name for this placement group. The name is unique across all placement groups in the region.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-placement-group
The resource group for this placement group
Examples:{ "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }
- resource_group
The unique identifier for this resource group
Possible values: length = 32, Value must match regular expression
^[0-9a-f]{32}$
Example:
fee82deba12e4c0fb69c3b09d1f12345
The name for this resource group
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
^[a-zA-Z0-9-_ ]+$
Example:
my-resource-group
The resource type
Possible values: [
placement_group
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The strategy for this placement group:
host_spread
: place on different compute hostspower_spread
: place on compute hosts that use different power sources
The enumerated values for this property may expand in the future.
Possible values: [
host_spread
,power_spread
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Status Code
The placement group was retrieved successfully
An invalid authentication token was provided
The provided token is not authorized for this operation
A placement group with the specified identifier could not be found or is not associated with the calling instance
Example responses
{ "created_at": "2020-12-29T19:55:00.000Z", "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::placement-group:r006-418fe842-a3e9-47b9-a938-1aa5bd632871", "id": "r006-418fe842-a3e9-47b9-a938-1aa5bd632871", "lifecycle_state": "stable", "name": "my-placement-group", "resource_group": { "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }, "resource_type": "placement_group", "strategy": "host_spread" }
List virtual network interfaces
This request lists virtual network interfaces targeting the calling instance
GET /metadata/v1/virtual_network_interfaces
Request
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/virtual_network_interfaces?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
A page of virtual network interfaces
Status Code
The virtual network interfaces were retrieved successfully
Example responses
{ "virtual_network_interfaces": [ { "allow_ip_spoofing": false, "auto_delete": true, "created_at": "2024-10-15T03:24:32.993Z", "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "enable_infrastructure_nat": false, "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "ips": [ { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" } ], "lifecycle_state": "stable", "mac_address": "02:00:04:00:C4:6A", "name": "my-virtual-network-interface", "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "protocol_state_filtering_mode": "auto", "resource_group": { "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }, "resource_type": "virtual_network_interface", "security_groups": [ { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271", "id": "r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271", "name": "my-security-group" } ], "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "target": { "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-attachment", "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "resource_type": "instance_network_attachment", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "virtual_network_interface": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "name": "my-virtual-network-interface", "resource_type": "virtual_network_interface" } }, "vpc": { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "id": "r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "name": "my-vpc", "resource_type": "vpc" }, "zone": { "name": "us-south-1" } }, { "allow_ip_spoofing": false, "auto_delete": true, "created_at": "2024-10-23T03:23:32.993Z", "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-fa41aecb-4f21-423d-8082-630bfba1e1d9", "enable_infrastructure_nat": false, "id": "0717-fa41aecb-4f21-423d-8082-630bfba1e1d9", "ips": [ { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, { "address": "10.0.2.10", "id": "0717-948a1ea9-0ffe-4c9e-aa7b-be4dc2d3e749", "name": "my-reserved-ip-z1-2", "resource_type": "subnet_reserved_ip" } ], "lifecycle_state": "stable", "mac_address": "02:00:04:00:C4:6B", "name": "my-virtual-network-interface-2", "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "protocol_state_filtering_mode": "auto", "resource_group": { "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }, "resource_type": "virtual_network_interface", "security_groups": [ { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271", "id": "r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271", "name": "my-security-group" } ], "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-c0461da9-04be-4a26-ac87-94e06c19b840", "id": "0717-c0461da9-04be-4a26-ac87-94e06c19b840", "ipv4_cidr_block": "10.0.2.0/24", "name": "my-subnet-z1-2", "resource_type": "subnet" }, "target": { "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-attachment", "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "resource_type": "instance_network_attachment", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "virtual_network_interface": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "name": "my-virtual-network-interface", "resource_type": "virtual_network_interface" } }, "vpc": { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "id": "r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "name": "my-vpc", "resource_type": "vpc" }, "zone": { "name": "us-south-1" } } ] }
Retrieve a virtual network interface
This request retrieves a virtual network interface targeting the calling instance.
GET /metadata/v1/virtual_network_interfaces/{id}
Request
Path Parameters
The virtual network interface identifier
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Query Parameters
The API version, in format
YYYY-MM-DD
. For the API behavior documented here, specify any date between2025-07-15
and2025-07-15
.Possible values: length = 10, Value must match regular expression
^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$
Example:
2024-06-23
The API maturity. For the API behavior documented here, specify
beta
.Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
curl -X GET "$vpc_metadata_api_endpoint/metadata/v1/virtual_network_interfaces/$id?version=2025-07-15&maturity=beta" -H "Authorization: Bearer $identity_token"
Response
Indicates whether source IP spoofing is allowed on this interface. If
false
, source IP spoofing is prevented on this interface. Iftrue
, source IP spoofing is allowed on this interface.Example:
true
Indicates whether this virtual network interface will be automatically deleted when
target
is deletedThe date and time that the virtual network interface was created
Possible values: 10 ≤ length ≤ 64, Value must match regular expression
^((?:(\d{4}-\d{2}-\d{2})T(\d{2}:\d{2}:\d{2}(?:\.\d+)?))(Z|[\+-]\d{2}:\d{2})?)$
The CRN for this virtual network interface
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef
If
true
:- The VPC infrastructure performs any needed NAT operations.
floating_ips
must not have more than one floating IP.
If
false
:- Packets are passed unchanged to/from the virtual network interface, allowing the workload to perform any needed NAT operations.
allow_ip_spoofing
must befalse
.- Can only be attached to a
target
with aresource_type
ofbare_metal_server_network_attachment
.
Example:
true
The unique identifier for this virtual network interface
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-54eb57ee-86f2-4796-90bb-d7874e0831ef
The reserved IPs bound to this virtual network interface.
May be empty when
lifecycle_state
ispending
.Possible values: number of items ≥ 0
The lifecycle state of the virtual network interface
Possible values: [
deleting
,failed
,pending
,stable
,suspended
,updating
,waiting
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Example:
stable
The name for this virtual network interface. The name is unique across all virtual network interfaces in the VPC.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-virtual-network-interface
The reserved IP for this virtual network interface.
Examples:{ "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }
- primary_ip
The IP address.
If the address has not yet been selected, the value will be
0.0.0.0
.This property may expand to support IPv6 addresses in the future.
Possible values: 7 ≤ length ≤ 15, Value must match regular expression
^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$
Example:
192.168.3.4
The unique identifier for this reserved IP
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb
The name for this reserved IP. The name is unique across all reserved IPs in a subnet.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-reserved-ip
The resource type
Possible values: [
subnet_reserved_ip
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The protocol state filtering mode used for this virtual network interface. If
auto
, protocol state packet filtering is enabled or disabled based on the virtual network interface'starget
resource type:bare_metal_server_network_attachment
: disabledinstance_network_attachment
: enabledshare_mount_target
: enabled
Protocol state filtering monitors each network connection flowing over this virtual network interface, and drops any packets that are invalid based on the current connection state and protocol. See Protocol state filtering mode) for more information.
Possible values: [
auto
,disabled
,enabled
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
Example:
auto
The resource group for this virtual network interface
Examples:{ "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }
- resource_group
The unique identifier for this resource group
Possible values: length = 32, Value must match regular expression
^[0-9a-f]{32}$
Example:
fee82deba12e4c0fb69c3b09d1f12345
The name for this resource group
Possible values: 1 ≤ length ≤ 40, Value must match regular expression
^[a-zA-Z0-9-_ ]+$
Example:
my-resource-group
The resource type
Possible values: [
virtual_network_interface
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The security groups for this virtual network interface.
Possible values: number of items ≥ 1
The associated subnet
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }
- subnet
The CRN for this subnet
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e
The unique identifier for this subnet
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e
The name for this subnet. The name is unique across all subnets in the VPC.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-subnet
The resource type
Possible values: [
subnet
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The target of this virtual network interface.
- target
The unique identifier for this instance network attachment
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
0717-d54eb633-98ea-459d-aa00-6a8e780175a7
The name for this instance network attachment. The name is unique across all network attachments for the instance.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-instance-network-attachment
The resource type
Possible values: [
instance_network_attachment
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
The VPC this virtual network interface resides in.
Examples:{ "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "id": "r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "name": "my-vpc", "resource_type": "vpc" }
- vpc
The CRN for this VPC
Possible values: 17 ≤ length ≤ 512, Value must match regular expression
^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\.\/]*$
Example:
crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b
The unique identifier for this VPC
Possible values: 1 ≤ length ≤ 64, Value must match regular expression
^[-0-9a-z_]+$
Example:
r006-4727d842-f94f-4a2d-824a-9bc9b02c523b
The name for this VPC. The name is unique across all VPCs in the region.
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^-?([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
my-vpc
The resource type
Possible values: [
vpc
]Possible values: 1 ≤ length ≤ 128, Value must match regular expression
^[a-z][a-z0-9]*(_[a-z0-9]+)*$
If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.
The zone this virtual network interface resides in.
Examples:{ "name": "us-south-1" }
- zone
The globally unique name for this zone
Possible values: 1 ≤ length ≤ 63, Value must match regular expression
^([a-z]|[a-z][-a-z0-9]*[a-z0-9]|[0-9][-a-z0-9]*([a-z]|[-a-z][-a-z0-9]*[a-z0-9]))$
Example:
us-south-1
The MAC address of the virtual network interface. May be absent if
lifecycle_state
ispending
.Possible values: length = 17, Value must match regular expression
^([0-9A-F]{2}:){5}[0-9A-F]{2}$
Example:
02:00:4D:45:45:4D
Status Code
The virtual network interface was retrieved successfully
A virtual network interface with the specified identifier could not be found or is not associated with the calling instance
Example responses
{ "allow_ip_spoofing": false, "auto_delete": true, "created_at": "2024-10-15T03:24:32.993Z", "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "enable_infrastructure_nat": false, "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "ips": [ { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" } ], "lifecycle_state": "stable", "mac_address": "02:00:04:00:C4:6A", "name": "my-virtual-network-interface", "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "protocol_state_filtering_mode": "auto", "resource_group": { "id": "fee82deba12e4c0fb69c3b09d1f12345", "name": "Default" }, "resource_type": "virtual_network_interface", "security_groups": [ { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271", "id": "r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271", "name": "my-security-group" } ], "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "target": { "id": "0717-d54eb633-98ea-459d-aa00-6a8e780175a7", "name": "my-instance-network-attachment", "primary_ip": { "address": "10.0.1.5", "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb", "name": "my-reserved-ip-z1", "resource_type": "subnet_reserved_ip" }, "resource_type": "instance_network_attachment", "subnet": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "id": "0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e", "name": "my-subnet", "resource_type": "subnet" }, "virtual_network_interface": { "crn": "crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "id": "0717-54eb57ee-86f2-4796-90bb-d7874e0831ef", "name": "my-virtual-network-interface", "resource_type": "virtual_network_interface" } }, "vpc": { "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "id": "r006-4727d842-f94f-4a2d-824a-9bc9b02c523b", "name": "my-vpc", "resource_type": "vpc" }, "zone": { "name": "us-south-1" } }
id=curlclassName=tab-item-selected