Methods

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• trusted_profile

  Identifies a trusted profile by a unique property.

  One of

  Change Request Parameter List

  TrustedProfileIdentityById

• access_token

  Always included*

  string

  The access token

  Possible values: 14 ≤ length ≤ 2000, Value must match regular expression ^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$

  Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50IjoiYWEyNDMyYjFmYTRkNGFjZTg5MWU5YjgwZmMxMDRlMzQiLCJzZWNyZXQiOiJRVzRnWlhoaGJYQnNaU0J6WldOeVpYUUsiLCJleHAiOjE3MjYwNzU1OTR9.UFDVzzGJ54Go9Z4jgyPSLG49zNx-AjHTQrJA6ee8KLI

• created_at

  Always included*

  date-time

  The date and time that the access token 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})?)$

  Example: 2021-03-22T21:50:14Z

• expires_at

  Always included*

  date-time

  The date and time that the access token will expire

  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})?)$

  Example: 2021-03-22T21:51:14Z

• expires_in

  Always included*

  integer

  Time in seconds before the access token expires

  Possible values: 5 ≤ value ≤ 3600

  Example: 60

Status Code

• 200

  The IAM access token was successfully generated.

• 400

  An invalid access token prototype object was provided.

• 401

  An invalid authentication token was provided

• 403

  The provided token is not authorized for this operation

Custom Headers

• Metadata-Flavor

  Required*

  string

  The metadata flavor. Currently, only ibm is supported.

  Allowable values: [ibm]

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• expires_in

  integer

  Time in seconds before the access token expires

  Possible values: 5 ≤ value ≤ 3600

  Default: 300

  Example: 60

• access_token

  Always included*

  string

  The access token

  Possible values: 14 ≤ length ≤ 2000, Value must match regular expression ^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$

  Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhY2NvdW50IjoiYWEyNDMyYjFmYTRkNGFjZTg5MWU5YjgwZmMxMDRlMzQiLCJzZWNyZXQiOiJRVzRnWlhoaGJYQnNaU0J6WldOeVpYUUsiLCJleHAiOjE3MjYwNzU1OTR9.UFDVzzGJ54Go9Z4jgyPSLG49zNx-AjHTQrJA6ee8KLI

• created_at

  Always included*

  date-time

  The date and time that the access token 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})?)$

  Example: 2021-03-22T21:50:14Z

• expires_at

  Always included*

  date-time

  The date and time that the access token will expire

  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})?)$

  Example: 2021-03-22T21:51:14Z

• expires_in

  Always included*

  integer

  Time in seconds before the access token expires

  Possible values: 5 ≤ value ≤ 3600

  Example: 60

Status Code

• 200

  The access token was created successfully.

• 400

  An invalid access token prototype object was provided.

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• csr

  Required*

  string

  A Public-Key Cryptography Standards (PKCS) #10 certification request provided in textual encoding described by RFC 7468.

  Certificate signing requests (CSRs) must meet the following requirements:

  • Version: v1 (value 0)
  • Subject public key algorithm: 2048-bit or 4096-bit RSA
  • Signature algorithm: SHA-256 with RSA encryption
  • Attributes: empty (constructed DER encoding value a0 00)
  • Subject: At least one of the following naming attributes must be specified:
    • C: The ISO 3166-1 alpha-2 country name (section 6.3.1 of X.520)
    • L: The locality name (section 6.3.4 of X.520)
    • ST: The full state or province name (section 6.3.5 of X.520)
    • O: The organization name (section 6.4.1 of X.520)
    • OU: The organizational unit name (section 6.4.2 of X.520)
    • No other naming attributes may be specified

  See Generating an instance identity certificate by using an instance identity access token, ITU X.520 10/2019, RFC 5280, and RFC 2985 for more information.

  Possible values: length ≥ 75, Value must match regular expression ^-----BEGIN CERTIFICATE REQUEST-----(\n|\r|\r\n)([0-9a-zA-Z\+\/=]{64}(\n|\r|\r\n))*([0-9a-zA-Z\+\/=]{1,63}(\n|\r|\r\n))?-----END CERTIFICATE REQUEST-----(\n|\r|\r\n)*$

  Examples:

  View

  -----BEGIN CERTIFICATE REQUEST-----
  MIICzzCCAbcCAQAwgYkxCzAJBgNVBAYTAlVTMRIwEAYDVQQIDAlNaW5uZXNvdGEx
  EjAQBgNVBAcMCVJvY2hlc3RlcjEMMAoGA1UECgwDSUJNMR4wHAYDVQQLDBVWaXJ0
  dWFsIFByaXZhdGUgQ2xvdWQxJDAiBgNVBAMMG1ZQQyBFeGFtcGxlIEludGVybWVk
  aWF0ZSBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMY78TrUhSrC
  SpeLXgS4JF+PpssYQpc9kJoOTJzUPqMocja6WL4xt/jvg60lCik185lkpClP+gSp
  h0DzXaXeMpm29HBu8JqXFN2I460jRYHf6NwhCvTO/qHyLkLU11zVEFl+a298AahA
  NU1ms1U2aaYYYXBkPLtN1Uyr6BeEtgyOi926wySdMNQzPSLGmgdpkuuFWDCI94y6
  8t/a8hhKGKtWtLQuAvXxE91eTZlJyETalQ5xhpGAcv+e1UQAlF8V3ELlunqD2BpO
  h6N3ipct+HopRdp/cQ/2weNUeDc2sTv9JR6vnGiOa9VpZ017RRPMC6RaGDJLgtKo
  igXrMrsnn9kCAwEAAaAAMA0GCSqGSIb3DQEBCwUAA4IBAQBCb71iIsm+ak94qO2+
  n7+WYLkIPCyIDb5mBCqJi5AL1ZC+WqbNVf4NqC6zS9qJbeQGOId5sGVLkdJjcccg
  f6SrE0mrC1h43ttwkZGNWML+rO0OlEuEDYdfsUQuH24t9KQNf2c6pmdLdchNovFz
  blhmHdjcUUAVYHHrFPgT0uvQVYEFLLIGa2ZHVeTJvZf4IVW2SiezSt/d6NsHi3s1
  rVZ8UIXXaFsOkgF65+D14hW+t9GzajSYY/IlU4E5YCRO9lHM/YmlbQRNXJgHDMta
  /uh2hhK3mMR7sfeBhHYvqs1hxBaLEka5rKOO61q8Px9eCC+WZx2nyHFILp86RyT0
  mL9R
  -----END CERTIFICATE REQUEST-----
  

  Copy to clipboard

• expires_in

  integer

  Time in seconds before the instance identity certificate expires

  Possible values: 300 ≤ value ≤ 3600

  Default: 3600

  Example: 1800

• certificates

  Always included*

  string[]

  The public key certificates, consisting of the instance identity certificate, and all intermediate CA certificates in its chain of trust. Certificates are based upon the X.509 v3 certificate format and the standard certificate extensions defined in RFC 5280.

  The certificates are issued by an IBM Cloud Virtual Private Cloud (VPC) certification authority (CA). VPC provides the public key infrastructure (PKI) establishing a chain of trust for use with VPC file share services.

  All certificates are provided in textual encoding described by RFC 7468.

  Possible values: 1 ≤ number of items ≤ 10, contains only unique items, Value must match regular expression ^-----BEGIN CERTIFICATE-----(\n|\r|\r\n)([0-9a-zA-Z\+\/=]{64}(\n|\r|\r\n))*([0-9a-zA-Z\+\/=]{1,63}(\n|\r|\r\n))?-----END CERTIFICATE-----(\n|\r|\r\n)+$

• created_at

  Always included*

  date-time

  The date and time that the instance identity certificate 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})?)$

  Example: 2022-11-01T13:50:14Z

• expires_at

  Always included*

  date-time

  The date and time that the instance identity certificate will expire

  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})?)$

  Example: 2022-11-01T14:20:14Z

• expires_in

  Always included*

  integer

  Time in seconds before the instance identity certificate expires

  Possible values: 300 ≤ value ≤ 3600

  Example: 1800

• id

  Always included*

  string

  The unique identifier for this instance identity certificate

  Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

  Example: 9fd84246-7df4-4667-94e4-8ecde51d5ac5

Status Code

• 201

  The instance identity certificate was created successfully.

• 400

  An invalid instance identity certificate prototype object was provided.

• 401

  An invalid authentication token was provided

• 403

  The provided token is not authorized for this operation

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• availability_policy

  Always included*

  The availability policy for this virtual server instance

  InstanceAvailabilityPolicy
  availability_policy

  host_failure

  Always included*

  string

  The action to perform if the compute host experiences a failure:

  • restart: Automatically restart the virtual server instance after host failure
  • stop: 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]+)*$

• bandwidth

  Always included*

  integer

  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

• boot_volume_attachment

  Always included*

  Boot volume attachment

  Examples:

  View

  {
    "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"
    }
  }

  Copy to clipboard
  VolumeAttachmentReferenceInstanceContext
  boot_volume_attachment

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

  device

  Information about how the volume is exposed to the instance operating system.

  This property may be absent if the volume attachment's status is not attached.

  Examples:

  View

  {
    "id": "0717-80b3e36e-41f4-40e9-bd56-beae81792a68-679qb"
  }

  Copy to clipboard

  VolumeAttachmentDevice

  device

  id

  Always included*

  string

  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_]+$

  volume

  The attached volume.

  This property will be absent if the volume has not yet been provisioned.

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard

  VolumeReferenceVolumeAttachmentContext

  volume

  crn

  Always included*

  string

  The CRN for this volume

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::volume:r006-1a6b7274-678d-4dfb-8981-c71dd9d4daa5

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  The resource type

  Possible values: [volume]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

  deleted

  Deleted

• cluster_network_attachments

  Always included*

  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

  InstanceClusterNetworkAttachmentReference[]

• confidential_compute_mode

  Always included*

  string

  The confidential compute mode for this virtual server instance.

  Possible values: [disabled,sgx]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

• created_at

  Always included*

  date-time

  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})?)$

• crn

  Always included*

  string

  The CRN for this virtual server instance

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::instance:0717_e21b7391-2ca2-4ab5-84a8-b92157a633b0

• disks

  Always included*

  The instance disks for this virtual server instance.

  Possible values: number of items ≥ 0

  InstanceDisk[]

• enable_secure_boot

  Always included*

  boolean

  Indicates whether secure boot is enabled for this virtual server instance.

• health_reasons

  Always included*

  The reasons for the current health_state (if any).

  Possible values: number of items ≥ 0

  InstanceHealthReason[]

• health_state

  Always included*

  string

  The health of this resource:

  • ok: No abnormal behavior detected
  • degraded: Experiencing compromised performance, capacity, or connectivity
  • faulted: Completely unreachable, inoperative, or otherwise entirely incapacitated
  • inapplicable: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of failed or deleting will have a health state of inapplicable. A pending 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

• id

  Always included*

  string

  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

• lifecycle_reasons

  Always included*

  The reasons for the current lifecycle_state (if any).

  Possible values: number of items ≥ 0

  InstanceLifecycleReason[]

• lifecycle_state

  Always included*

  LifecycleState

  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

• memory

  Always included*

  integer

  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

• metadata_service

  Always included*

  The metadata service configuration

  InstanceMetadataService

• name

  Always included*

  string

  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

• network_attachments

  Always included*

  The network attachments for this virtual server instance, including the primary network attachment.

  Possible values: number of items ≥ 0, contains only unique items

  InstanceNetworkAttachmentReference[]

• network_interfaces

  Always included*

  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

  NetworkInterfaceInstanceContextReference[]

• numa_count

  Always included*

  integer

  The number of NUMA nodes this virtual server instance is provisioned on.

  Possible values: value ≥ 1

  Example: 2

• primary_network_interface

  Always included*

  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:

  View

  {
    "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"
    }
  }

  Copy to clipboard
  NetworkInterfaceInstanceContextReference
  primary_network_interface

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  primary_ipv4_address

  Always included*

  string

  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

  resource_type

  Always included*

  string

  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]+)*$

  subnet

  Always included*

  The associated subnet

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard

  SubnetReference

  subnet

  crn

  Always included*

  string

  The CRN for this subnet

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  The resource type

  Possible values: [subnet]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

• profile

  Always included*

  The profile for this virtual server instance

  Examples:

  View

  {
    "name": "bx2-4x16",
    "resource_type": "instance_profile"
  }

  Copy to clipboard
  InstanceProfileReference
  profile

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  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]+)*$

• reservation_affinity

  Always included*
  InstanceReservationAffinity

• resource_group

  Always included*

  The resource group for this instance

  Examples:

  View

  {
    "id": "fee82deba12e4c0fb69c3b09d1f12345",
    "name": "Default"
  }

  Copy to clipboard
  ResourceGroupReference
  resource_group

  id

  Always included*

  string

  The unique identifier for this resource group

  Possible values: length = 32, Value must match regular expression ^[0-9a-f]{32}$

  Example: fee82deba12e4c0fb69c3b09d1f12345

  name

  Always included*

  string

  The name for this resource group

  Possible values: 1 ≤ length ≤ 40, Value must match regular expression ^[a-zA-Z0-9-_ ]+$

  Example: my-resource-group

• resource_type

  Always included*

  string

  The resource type

  Possible values: [instance]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

• startable

  Always included*

  boolean

  Indicates whether the state of the virtual server instance permits a start request.

• status

  Always included*

  string

  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]+)*$

• status_reasons

  Always included*

  The reasons for the current status (if any).

  Possible values: number of items ≥ 0

  InstanceStatusReason[]

• total_network_bandwidth

  Always included*

  int32

  The amount of bandwidth (in megabits per second) allocated exclusively to instance network attachments or instance network interfaces.

  Example: 500

• total_volume_bandwidth

  Always included*

  int32

  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

• vcpu

  Always included*

  The virtual server instance VCPU configuration

  Examples:

  View

  {
    "architecture": "amd64",
    "count": 56,
    "manufacturer": "intel"
  }

  Copy to clipboard
  InstanceVCPU

• volume_attachments

  Always included*

  The volume attachments for this virtual server instance, including the boot volume attachment.

  Possible values: number of items ≥ 1, contains only unique items

  VolumeAttachmentReferenceInstanceContext[]

• vpc

  Always included*

  The VPC this virtual server instance resides in

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard
  VPCReference
  vpc

  crn

  Always included*

  string

  The CRN for this VPC

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  The resource type

  Possible values: [vpc]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

• zone

  Always included*

  The zone this virtual server instance resides in

  Examples:

  View

  {
    "name": "us-south-1"
  }

  Copy to clipboard
  ZoneReference
  zone

  name

  Always included*

  string

  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

• catalog_offering

  If present, this virtual server instance was provisioned from a catalog.

  InstanceCatalogOffering
  catalog_offering

  version

  Always included*

  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.

  CatalogOfferingVersionReference

  version

  crn

  Always included*

  string

  The CRN for this version of a catalog offering

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  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

  plan

  The billing plan used for the catalog offering version.

  If absent, no billing plan is in use (free).

  CatalogOfferingVersionPlanReference

  plan

  crn

  Always included*

  string

  The CRN for this catalog offering version's billing plan

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  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

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

• cluster_network

  If present, the cluster network that this virtual server instance resides in

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard
  ClusterNetworkReference
  cluster_network

  crn

  Always included*

  string

  The CRN for this cluster network

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::cluster-network:0717-da0df18c-7598-4633-a648-fdaac28a5573

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  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]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

• dedicated_host

  If present, the dedicated host this virtual server instance has been placed on.

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard
  DedicatedHostReference
  dedicated_host

  crn

  Always included*

  string

  The CRN for this dedicated host

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::dedicated-host:0717-1e09281b-f177-46fb-baf1-bc152b2e391a

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  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]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

• gpu

  The virtual server instance GPU configuration

  InstanceGPU

• image

  The image the virtual server instance was provisioned from

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard
  ImageReference
  image

  crn

  Always included*

  string

  The CRN for this image

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::image:r006-72b27b5c-f4b0-48bb-b954-5becc7c1dcb8

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  The resource type

  Possible values: [image]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

  remote

  If present, this property indicates that the resource associated with this reference is remote and therefore may not be directly retrievable.

  ImageRemote

• placement_target

  The placement restrictions for the virtual server instance

  One of

  Change Request Parameter List

  DedicatedHostGroupReference
  placement_target

  crn

  Always included*

  string

  The CRN for this dedicated host group

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::dedicated-host-group:0717-bcc5b834-1258-4b9c-c3b4-43bc9cf5cde0

  id

  Always included*

  string

  The unique identifier for this dedicated host group

  Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

  Example: 0717-bcc5b834-1258-4b9c-c3b4-43bc9cf5cde0

  name

  Always included*

  string

  The name for this dedicated host group. The name is unique across all dedicated host 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-dedicated-host-group

  resource_type

  Always included*

  string

  The resource type

  Possible values: [dedicated_host_group]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

  deleted

  Deleted

• primary_network_attachment

  The primary network attachment for this virtual server instance

  Examples:

  View

  {
    "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",
      "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"
    }
  }

  Copy to clipboard
  InstanceNetworkAttachmentReference
  primary_network_attachment

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  primary_ip

  Always included*

  The primary IP address of the virtual network interface for the instance network attachment

  Examples:

  View

  {
    "address": "10.0.1.5",
    "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb",
    "name": "my-reserved-ip",
    "resource_type": "subnet_reserved_ip"
  }

  Copy to clipboard

  ReservedIPReference

  primary_ip

  address

  Always included*

  IPv4

  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

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  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]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

  resource_type

  Always included*

  string

  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]+)*$

  subnet

  Always included*

  The subnet of the virtual network interface for the instance network attachment

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard

  SubnetReference

  subnet

  crn

  Always included*

  string

  The CRN for this subnet

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  The resource type

  Possible values: [subnet]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

  virtual_network_interface

  Always included*

  The virtual network interface for this instance network attachment

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard

  VirtualNetworkInterfaceReferenceAttachmentContext

  virtual_network_interface

  crn

  Always included*

  string

  The CRN for this virtual network interface

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  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]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

• reservation

  The reservation used by this virtual server instance.

  If absent, no reservation is in use.

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard
  ReservationReference
  reservation

  crn

  Always included*

  string

  The CRN for this reservation

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::reservation:0717-ba49df72-37b8-43ac-98da-f8e029de0e63

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  The resource type

  Possible values: [reservation]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

Status Code

• 200

  The instance was retrieved successfully

• 401

  An invalid authentication token was provided

• 403

  The provided token is not authorized for this operation

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• start

  string

  A server-provided token determining what resource to start the page on

  Possible values: 1 ≤ length ≤ 4096, Value must match regular expression ^[ -~]+$

• limit

  int32

  The number of resources to return on a page

  Possible values: 1 ≤ value ≤ 100

  Default: 50

• cluster_network_attachments

  Always included*

  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.

  InstanceClusterNetworkAttachment[]

• first

  Always included*

  A link to the first page of resources

  Examples:

  View

  {
    "href": "https://api.metadata.cloud.ibm.com/metadata/v1/instance/cluster_network_attachments?limit=20"
  }

  Copy to clipboard
  PageLink
  first

  href

  Always included*

  string

  The URL for a page of resources

  Possible values: Value must match regular expression ^http(s)?:\/\/([^\/?#]*)([^?#]*)(\?([^#]*))?(#(.*))?$

• limit

  Always included*

  int32

  The maximum number of resources that can be returned by the request

  Possible values: 1 ≤ value ≤ 100

  Example: 20

• total_count

  Always included*

  int32

  The total number of resources across all pages

  Possible values: value ≥ 0

  Example: 132

• next

  A link to the next page of resources. This property is present for all pages except the last page

  Examples:

  View

  {
    "href": "https://api.metadata.cloud.ibm.com/metadata/v1/instance/cluster_network_attachments?start=0717-fb880975-db45-4459-8548-64e3995ac213&limit=20"
  }

  Copy to clipboard
  PageLink
  next

  href

  Always included*

  string

  The URL for a page of resources

  Possible values: Value must match regular expression ^http(s)?:\/\/([^\/?#]*)([^?#]*)(\?([^#]*))?(#(.*))?$

Status Code

• 200

  The instance cluster network attachments were retrieved successfully

• 401

  An invalid authentication token was provided

• 403

  The provided token is not authorized for this operation

Path Parameters

• id

  Required*

  string

  The instance cluster network attachment identifier

  Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• cluster_network_interface

  Always included*

  The cluster network interface for this instance cluster network attachment

  Examples:

  View

  {
    "id": "0717-ffc092f7-5d02-4b93-ab69-26860529b9fb",
    "name": "my-cluster-network-interface",
    "primary_ip": {
      "address": "10.1.0.6",
      "id": "63341ffa-1037-4b50-be40-676e3e9ac0c7",
      "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"
    }
  }

  Copy to clipboard
  ClusterNetworkInterfaceReference
  cluster_network_interface

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  primary_ip

  Always included*

  The primary IP for this cluster network interface

  Examples:

  View

  {
    "address": "10.1.0.6",
    "id": "63341ffa-1037-4b50-be40-676e3e9ac0c7",
    "name": "my-cluster-network-subnet-reserved-ip",
    "resource_type": "cluster_network_subnet_reserved_ip"
  }

  Copy to clipboard

  ClusterNetworkSubnetReservedIPReference

  primary_ip

  address

  Always included*

  IPv4

  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

  id

  Always included*

  string

  The unique identifier for this cluster network subnet reserved IP

  Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

  Example: 6d353a0f-aeb1-4ae1-832e-1110d10981bb

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  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]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

  resource_type

  Always included*

  string

  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]+)*$

  subnet

  Always included*

  Examples:

  View

  {
    "id": "0717-7931845c-65c4-4b0a-80cd-7d9c1a6d7930",
    "name": "my-cluster-network-subnet",
    "resource_type": "cluster_network_subnet"
  }

  Copy to clipboard

  ClusterNetworkSubnetReference

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

• id

  Always included*

  string

  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

• lifecycle_reasons

  Always included*

  The reasons for the current lifecycle_state (if any).

  Possible values: number of items ≥ 0

  InstanceClusterNetworkAttachmentLifecycleReason[]

• lifecycle_state

  Always included*

  LifecycleState

  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

• name

  Always included*

  string

  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

• resource_type

  Always included*

  string

  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]+)*$

• before

  The instance cluster network attachment that is immediately before. If absent, this is the last instance cluster network attachment.

  Examples:

  View

  {
    "cluster_network_interface": {
      "id": "0717-ffc092f7-5d02-4b93-ab69-26860529b9fb",
      "name": "my-cluster-network-interface",
      "primary_ip": {
        "address": "10.1.0.6",
        "id": "63341ffa-1037-4b50-be40-676e3e9ac0c7",
        "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"
  }

  Copy to clipboard
  InstanceClusterNetworkAttachmentBefore

Status Code

• 200

  The instance cluster network attachment was retrieved successfully

• 401

  An invalid authentication token was provided

• 403

  The provided token is not authorized for this operation

• 404

  A cluster network attachment with the specified identifier could not be found or is not associated with the calling instance

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• keys

  Always included*

  The public SSH keys used at instance initialization.

  KeyReference[]

• user_data

  Always included*

  string

  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]*$

• default_trusted_profile

  The default trusted profile configuration specified at virtual server instance creation. If absent, no default trusted profile was specified.

  InstanceInitializationDefaultTrustedProfile
  default_trusted_profile

  auto_link

  Always included*

  boolean

  If set to true, the system created a link to the specified target 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

  target

  Always included*

  The default IAM trusted profile to use for this virtual server instance

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard

  TrustedProfileReference

  target

  crn

  Always included*

  string

  The CRN for this trusted profile

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:iam-identity::a/aa2432b1fa4d4ace891e9b80fc104e34::profile:Profile-9fd84246-7df4-4667-94e4-8ecde51d5ac5

  id

  Always included*

  string

  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

  resource_type

  Always included*

  string

  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]+)*$

• password

  InstanceInitializationPassword

Status Code

• 200

  The initialization information was retrieved successfully

• 401

  An invalid authentication token was provided

• 403

  The provided token is not authorized for this operation

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• network_attachments

  Always included*

  The network attachments for the instance

  InstanceNetworkAttachment[]

Status Code

• 200

  The instance network attachments were retrieved successfully

• 401

  An invalid authentication token was provided

• 403

  The provided token is not authorized for this operation

Path Parameters

• id

  Required*

  string

  The instance network attachment identifier

  Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• created_at

  Always included*

  date-time

  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})?)$

• id

  Always included*

  string

  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

• lifecycle_state

  Always included*

  LifecycleState

  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

• name

  Always included*

  string

  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

• port_speed

  Always included*

  integer

  The port speed for this instance network attachment in Mbps

  Example: 1000

• primary_ip

  Always included*

  The primary IP address of the virtual network interface for the instance network attachment

  Examples:

  View

  {
    "address": "10.0.1.5",
    "id": "0717-6d353a0f-aeb1-4ae1-832e-1110d10981bb",
    "name": "my-reserved-ip",
    "resource_type": "subnet_reserved_ip"
  }

  Copy to clipboard
  ReservedIPReference
  primary_ip

  address

  Always included*

  IPv4

  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

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  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]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

• resource_type

  Always included*

  string

  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]+)*$

• subnet

  Always included*

  The subnet of the virtual network interface for the instance network attachment

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard
  SubnetReference
  subnet

  crn

  Always included*

  string

  The CRN for this subnet

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  The resource type

  Possible values: [subnet]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

• type

  Always included*

  string

  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

• virtual_network_interface

  Always included*

  The virtual network interface for this instance network attachment

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard
  VirtualNetworkInterfaceReferenceAttachmentContext
  virtual_network_interface

  crn

  Always included*

  string

  The CRN for this virtual network interface

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::virtual-network-interface:0717-54eb57ee-86f2-4796-90bb-d7874e0831ef

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  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

• 200

  The instance network attachment was retrieved successfully

• 401

  An invalid authentication token was provided

• 403

  The provided token is not authorized for this operation

• 404

  A network attachment with the specified identifier could not be found or is not associated with the calling instance

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• network_interfaces

  Always included*

  The network interfaces for the instance

  NetworkInterface[]

Status Code

• 200

  The instance network interfaces were retrieved successfully

• 401

  An invalid authentication token was provided

• 403

  The provided token is not authorized for this operation

Path Parameters

• id

  Required*

  string

  The instance network interface identifier

  Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-10-22 and 2024-11-19.

  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

• maturity

  Required*

  string

  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]+)*$

• allow_ip_spoofing

  Always included*

  boolean

  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

• created_at

  Always included*

  date-time

  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})?)$

• floating_ips

  Always included*

  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.

  FloatingIPReference[]

• id

  Always included*

  string

  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

• name

  Always included*

  string

  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

• port_speed

  Always included*

  integer

  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

• primary_ipv4_address

  Always included*

  string

  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

• resource_type

  Always included*

  string

  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]+)*$

• security_groups

  Always included*

  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

  SecurityGroupReference[]

• status

  Always included*

  string

  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

• subnet

  Always included*

  The associated subnet

  Examples:

  View

  {
    "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"
  }

  Copy to clipboard
  SubnetReference
  subnet

  crn

  Always included*

  string

  The CRN for this subnet

  Possible values: 9 ≤ 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-_\.\/]*$|^crn:\[\.\.\.\]$

  Example: crn:v1:bluemix:public:is:us-south-1:a/aa2432b1fa4d4ace891e9b80fc104e34::subnet:0717-7ec86020-1c6e-4889-b3f0-a15f2e50f87e

  id

  Always included*

  string

  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

  name

  Always included*

  string

  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

  resource_type

  Always included*

  string

  The resource type

  Possible values: [subnet]

  Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

  deleted

  If present, this property indicates the referenced resource has been deleted, and provides some supplementary information.

  Deleted

• type

  Always included*

  string

  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

• 200

  The instance network interface was retrieved successfully

• 401

  An invalid authentication token was provided

• 403

  The provided token is not authorized for this operation

• 404

  An instance network interface with the specified identifier could not be found or is not associated with the calling instance