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-12-17 and 2024-12-17.

  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

• generation

  Required*

  int32

  The infrastructure generation. For the API behavior documented here, specify 2.

  Allowable values: [2]

• 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

• resource_group.id

  string

  Filters the collection to resources with a resource_group.id property matching the specified identifier.

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

• classic_access

  boolean

  Filters the collection to VPCs with a classic_access property matching the specified value.

  Example: true

• first

  Always included*

  A link to the first page of resources

  Examples:

  View

  {
    "href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs?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

• vpcs

  Always included*

  A page of VPCs

  VPC[]

• next

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

  Examples:

  View

  {
    "href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs?start=9d5a91a3e2cbd233b5a5b33436855ed1&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 VPCs were retrieved successfully.

Query Parameters

• version

  Required*

  string

  The API version, in format YYYY-MM-DD. For the API behavior documented here, specify any date between 2024-12-17 and 2024-12-17.

  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

• generation

  Required*

  int32

  The infrastructure generation. For the API behavior documented here, specify 2.

  Allowable values: [2]

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

• address_prefix_management

  string

  Indicates whether a default address prefix will be automatically created for each zone in this VPC. If manual, this VPC will be created with no default address prefixes.

  Since address prefixes are managed identically regardless of whether they were automatically created, the value is not preserved as a VPC property.

  Allowable values: [auto,manual]

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

  Default: auto

• classic_access

  boolean

  Indicates whether this VPC will be connected to Classic Infrastructure. If true, this VPC's resources will have private network connectivity to the account's Classic Infrastructure resources. Only one VPC, per region, may be connected in this way. This value is set at creation and subsequently immutable.

  This property has been deprecated. Instead, use a Transit Gateway to connect this VPC to Classic Infrastructure. For more information, see upcoming changes.

  Default: false

• dns

  The DNS configuration for this VPC.

  If unspecified, the system will assign DNS servers capable of resolving hosts and endpoint gateways within this VPC, and hosts on the internet.

  VPCDNSPrototype

• name

  string

  The name for this VPC. The name must not be used by another VPC 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-vpc

• resource_group

  The resource group to use. If unspecified, the account's default resource group will be used.

  ResourceGroupIdentityById

• classic_access

  Always included*

  boolean

  Indicates whether this VPC is connected to Classic Infrastructure. If true, this VPC's resources have private network connectivity to the account's Classic Infrastructure resources. Only one VPC, per region, may be connected in this way. This value is set at creation and subsequently immutable.

• created_at

  Always included*

  date-time

  The date and time that the VPC 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 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

• default_network_acl

  Always included*

  The default network ACL to use for subnets created in this VPC.

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::network-acl:r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/network_acls/r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf",
    "id": "r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf",
    "name": "my-network-acl"
  }

  Copy to clipboard
  NetworkACLReference
  default_network_acl

  crn

  Always included*

  string

  The CRN for this network ACL

  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::network-acl:r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

  href

  Always included*

  string

  The URL for this network ACL

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/network_acls/r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

  id

  Always included*

  string

  The unique identifier for this network ACL

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

  Example: r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

  name

  Always included*

  string

  The name for this network ACL. The name is unique across all network ACLs for 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-network-acl

  deleted

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

  Deleted

• default_routing_table

  Always included*

  The default routing table to use for subnets created in this VPC.

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc-routing-table:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/r006-6885e83f-03b2-4603-8a86-db2a0f55c840",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs/r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/routing_tables/r006-6885e83f-03b2-4603-8a86-db2a0f55c840",
    "id": "r006-6885e83f-03b2-4603-8a86-db2a0f55c840",
    "name": "my-routing-table",
    "resource_type": "routing_table"
  }

  Copy to clipboard
  RoutingTableReference
  default_routing_table

  crn

  Always included*

  string

  The CRN for this VPC routing table

  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-routing-table:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/r006-6885e83f-03b2-4603-8a86-db2a0f55c840

  href

  Always included*

  string

  The URL for this routing table

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/vpcs/r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/routing_tables/r006-6885e83f-03b2-4603-8a86-db2a0f55c840

  id

  Always included*

  string

  The unique identifier for this routing table

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

  Example: r006-6885e83f-03b2-4603-8a86-db2a0f55c840

  name

  Always included*

  string

  The name for this routing table. The name is unique across all routing tables for 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-routing-table-1

  resource_type

  Always included*

  string

  The resource type

  Possible values: [routing_table]

  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

• default_security_group

  Always included*

  The default security group for this VPC. Resources created in this VPC that allow a security group to be optionally specified will use this security group by default.

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/security_groups/r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271",
    "id": "r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271",
    "name": "my-security-group"
  }

  Copy to clipboard
  SecurityGroupReference
  default_security_group

  crn

  Always included*

  string

  The CRN for this security 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:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

  href

  Always included*

  string

  The URL for this security group

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/security_groups/r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

  id

  Always included*

  string

  The unique identifier for this security group

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

  Example: r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

  name

  Always included*

  string

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

  deleted

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

  Deleted

• dns

  Always included*

  The DNS configuration for this VPC.

  VPCDNS

• health_reasons

  Always included*

  The reasons for the current health_state (if any).

  Possible values: number of items ≥ 0

  VPCHealthReason[]

• 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

• href

  Always included*

  string

  The URL for this VPC

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/vpcs/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_group

  Always included*

  The resource group for this VPC

  Examples:

  View

  {
    "href": "https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345",
    "id": "fee82deba12e4c0fb69c3b09d1f12345",
    "name": "Default"
  }

  Copy to clipboard
  ResourceGroupReference
  resource_group

  href

  Always included*

  string

  The URL for this resource group

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

  Example: https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345

  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: [vpc]

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

• status

  Always included*

  string

  The status of this VPC.

  The enumerated values for this property may expand in the future.

  Possible values: [available,deleting,failed,pending]

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

• cse_source_ips

  The CSE (Cloud Service Endpoint) source IP addresses for the VPC. The VPC will have at least one CSE source IP address per zone.

  The maximum number of items for this property may expand in the future.

  Possible values: 3 ≤ number of items ≤ 25

  VPCCSESourceIP[]

Status Code

• 201

  The VPC was created successfully.

• 400

  An invalid VPC prototype object was provided.

• 409

  The VPC prototype object conflicts with another VPC in the region.

Custom Headers

• If-Match

  string

  If present, the request will fail if the specified ETag value does not match the resource's current ETag value.

  Possible values: 2 ≤ length ≤ 512, Value must match regular expression ^(W\/)?"([\x21\x23-\x5B\x5D-\x7E\x80-\xFF]*|\r\n[\t ]+)*"$

  Example: W/"96d225c4-56bd-43d9-98fc-d7148e5c5028"

Path Parameters

• id

  Required*

  string

  The VPC 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-12-17 and 2024-12-17.

  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

• generation

  Required*

  int32

  The infrastructure generation. For the API behavior documented here, specify 2.

  Allowable values: [2]

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

Status Code

• 204

  The VPC was deleted successfully.

• 404

  A VPC with the specified identifier could not be found.

• 409

  The VPC is in use and cannot be deleted.

• 412

  The provided If-Match value does not match the current ETag value of the VPC.

Path Parameters

• id

  Required*

  string

  The VPC 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-12-17 and 2024-12-17.

  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

• generation

  Required*

  int32

  The infrastructure generation. For the API behavior documented here, specify 2.

  Allowable values: [2]

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

• classic_access

  Always included*

  boolean

  Indicates whether this VPC is connected to Classic Infrastructure. If true, this VPC's resources have private network connectivity to the account's Classic Infrastructure resources. Only one VPC, per region, may be connected in this way. This value is set at creation and subsequently immutable.

• created_at

  Always included*

  date-time

  The date and time that the VPC 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 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

• default_network_acl

  Always included*

  The default network ACL to use for subnets created in this VPC.

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::network-acl:r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/network_acls/r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf",
    "id": "r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf",
    "name": "my-network-acl"
  }

  Copy to clipboard
  NetworkACLReference
  default_network_acl

  crn

  Always included*

  string

  The CRN for this network ACL

  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::network-acl:r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

  href

  Always included*

  string

  The URL for this network ACL

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/network_acls/r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

  id

  Always included*

  string

  The unique identifier for this network ACL

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

  Example: r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

  name

  Always included*

  string

  The name for this network ACL. The name is unique across all network ACLs for 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-network-acl

  deleted

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

  Deleted

• default_routing_table

  Always included*

  The default routing table to use for subnets created in this VPC.

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc-routing-table:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/r006-6885e83f-03b2-4603-8a86-db2a0f55c840",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs/r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/routing_tables/r006-6885e83f-03b2-4603-8a86-db2a0f55c840",
    "id": "r006-6885e83f-03b2-4603-8a86-db2a0f55c840",
    "name": "my-routing-table",
    "resource_type": "routing_table"
  }

  Copy to clipboard
  RoutingTableReference
  default_routing_table

  crn

  Always included*

  string

  The CRN for this VPC routing table

  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-routing-table:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/r006-6885e83f-03b2-4603-8a86-db2a0f55c840

  href

  Always included*

  string

  The URL for this routing table

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/vpcs/r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/routing_tables/r006-6885e83f-03b2-4603-8a86-db2a0f55c840

  id

  Always included*

  string

  The unique identifier for this routing table

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

  Example: r006-6885e83f-03b2-4603-8a86-db2a0f55c840

  name

  Always included*

  string

  The name for this routing table. The name is unique across all routing tables for 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-routing-table-1

  resource_type

  Always included*

  string

  The resource type

  Possible values: [routing_table]

  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

• default_security_group

  Always included*

  The default security group for this VPC. Resources created in this VPC that allow a security group to be optionally specified will use this security group by default.

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/security_groups/r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271",
    "id": "r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271",
    "name": "my-security-group"
  }

  Copy to clipboard
  SecurityGroupReference
  default_security_group

  crn

  Always included*

  string

  The CRN for this security 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:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

  href

  Always included*

  string

  The URL for this security group

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/security_groups/r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

  id

  Always included*

  string

  The unique identifier for this security group

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

  Example: r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

  name

  Always included*

  string

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

  deleted

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

  Deleted

• dns

  Always included*

  The DNS configuration for this VPC.

  VPCDNS

• health_reasons

  Always included*

  The reasons for the current health_state (if any).

  Possible values: number of items ≥ 0

  VPCHealthReason[]

• 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

• href

  Always included*

  string

  The URL for this VPC

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/vpcs/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_group

  Always included*

  The resource group for this VPC

  Examples:

  View

  {
    "href": "https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345",
    "id": "fee82deba12e4c0fb69c3b09d1f12345",
    "name": "Default"
  }

  Copy to clipboard
  ResourceGroupReference
  resource_group

  href

  Always included*

  string

  The URL for this resource group

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

  Example: https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345

  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: [vpc]

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

• status

  Always included*

  string

  The status of this VPC.

  The enumerated values for this property may expand in the future.

  Possible values: [available,deleting,failed,pending]

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

• cse_source_ips

  The CSE (Cloud Service Endpoint) source IP addresses for the VPC. The VPC will have at least one CSE source IP address per zone.

  The maximum number of items for this property may expand in the future.

  Possible values: 3 ≤ number of items ≤ 25

  VPCCSESourceIP[]

Status Code

• 200

  The VPC was retrieved successfully.

• 404

  A VPC with the specified identifier could not be found.

Custom Headers

• If-Match

  string

  If present, the request will fail if the specified ETag value does not match the resource's current ETag value. Required if the request body includes an array.

  Possible values: 2 ≤ length ≤ 512, Value must match regular expression ^(W\/)?"([\x21\x23-\x5B\x5D-\x7E\x80-\xFF]*|\r\n[\t ]+)*"$

  Example: W/"96d225c4-56bd-43d9-98fc-d7148e5c5028"

Path Parameters

• id

  Required*

  string

  The VPC 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-12-17 and 2024-12-17.

  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

• generation

  Required*

  int32

  The infrastructure generation. For the API behavior documented here, specify 2.

  Allowable values: [2]

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

• dns

  The DNS configuration for this VPC.

  VPCDNSPatch

• name

  string

  The name for this VPC. The name must not be used by another VPC in the region.

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

  Example: my-vpc

• classic_access

  Always included*

  boolean

  Indicates whether this VPC is connected to Classic Infrastructure. If true, this VPC's resources have private network connectivity to the account's Classic Infrastructure resources. Only one VPC, per region, may be connected in this way. This value is set at creation and subsequently immutable.

• created_at

  Always included*

  date-time

  The date and time that the VPC 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 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

• default_network_acl

  Always included*

  The default network ACL to use for subnets created in this VPC.

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::network-acl:r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/network_acls/r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf",
    "id": "r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf",
    "name": "my-network-acl"
  }

  Copy to clipboard
  NetworkACLReference
  default_network_acl

  crn

  Always included*

  string

  The CRN for this network ACL

  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::network-acl:r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

  href

  Always included*

  string

  The URL for this network ACL

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/network_acls/r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

  id

  Always included*

  string

  The unique identifier for this network ACL

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

  Example: r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

  name

  Always included*

  string

  The name for this network ACL. The name is unique across all network ACLs for 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-network-acl

  deleted

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

  Deleted

• default_routing_table

  Always included*

  The default routing table to use for subnets created in this VPC.

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc-routing-table:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/r006-6885e83f-03b2-4603-8a86-db2a0f55c840",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs/r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/routing_tables/r006-6885e83f-03b2-4603-8a86-db2a0f55c840",
    "id": "r006-6885e83f-03b2-4603-8a86-db2a0f55c840",
    "name": "my-routing-table",
    "resource_type": "routing_table"
  }

  Copy to clipboard
  RoutingTableReference
  default_routing_table

  crn

  Always included*

  string

  The CRN for this VPC routing table

  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-routing-table:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/r006-6885e83f-03b2-4603-8a86-db2a0f55c840

  href

  Always included*

  string

  The URL for this routing table

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/vpcs/r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/routing_tables/r006-6885e83f-03b2-4603-8a86-db2a0f55c840

  id

  Always included*

  string

  The unique identifier for this routing table

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

  Example: r006-6885e83f-03b2-4603-8a86-db2a0f55c840

  name

  Always included*

  string

  The name for this routing table. The name is unique across all routing tables for 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-routing-table-1

  resource_type

  Always included*

  string

  The resource type

  Possible values: [routing_table]

  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

• default_security_group

  Always included*

  The default security group for this VPC. Resources created in this VPC that allow a security group to be optionally specified will use this security group by default.

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/security_groups/r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271",
    "id": "r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271",
    "name": "my-security-group"
  }

  Copy to clipboard
  SecurityGroupReference
  default_security_group

  crn

  Always included*

  string

  The CRN for this security 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:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

  href

  Always included*

  string

  The URL for this security group

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/security_groups/r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

  id

  Always included*

  string

  The unique identifier for this security group

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

  Example: r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

  name

  Always included*

  string

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

  deleted

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

  Deleted

• dns

  Always included*

  The DNS configuration for this VPC.

  VPCDNS

• health_reasons

  Always included*

  The reasons for the current health_state (if any).

  Possible values: number of items ≥ 0

  VPCHealthReason[]

• 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

• href

  Always included*

  string

  The URL for this VPC

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/vpcs/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_group

  Always included*

  The resource group for this VPC

  Examples:

  View

  {
    "href": "https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345",
    "id": "fee82deba12e4c0fb69c3b09d1f12345",
    "name": "Default"
  }

  Copy to clipboard
  ResourceGroupReference
  resource_group

  href

  Always included*

  string

  The URL for this resource group

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

  Example: https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345

  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: [vpc]

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

• status

  Always included*

  string

  The status of this VPC.

  The enumerated values for this property may expand in the future.

  Possible values: [available,deleting,failed,pending]

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

• cse_source_ips

  The CSE (Cloud Service Endpoint) source IP addresses for the VPC. The VPC will have at least one CSE source IP address per zone.

  The maximum number of items for this property may expand in the future.

  Possible values: 3 ≤ number of items ≤ 25

  VPCCSESourceIP[]

Status Code

• 200

  The VPC was updated successfully.

• 400

  An invalid VPC patch was provided.

• 404

  A VPC with the specified identifier could not be found.

• 409

  The VPC patch conflicts with another VPC in the region, or the VPC patch has one or more of:

  • dns.enable_hub incompatible with dns.resolution_binding_count
  • dns.enable_hub incompatible with allow_dns_resolution_binding values for endpoint gateways residing in the VPC
  • dns.resolver.type incompatible with dns.resolver.servers
  • dns.resolver.type incompatible with dns.resolver.vpc

• 412

  The provided If-Match value does not match the current ETag value of the VPC.

Path Parameters

• id

  Required*

  string

  The VPC 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-12-17 and 2024-12-17.

  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

• generation

  Required*

  int32

  The infrastructure generation. For the API behavior documented here, specify 2.

  Allowable values: [2]

• 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 network ACL 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 network ACL

  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::network-acl:r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

• href

  Always included*

  string

  The URL for this network ACL

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/network_acls/r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

• id

  Always included*

  string

  The unique identifier for this network ACL

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

  Example: r006-a4e28308-8ee7-46ab-8108-9f881f22bdbf

• name

  Always included*

  string

  The name of the default network ACL created for a VPC. The name will be a hyphenated list of randomly-selected words at creation, but may be changed.

  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: mnemonic-ersatz-eatery-mythology

• resource_group

  Always included*

  The resource group for the default network ACL for a VPC. Set to the VPC's resource group at creation.

  Examples:

  View

  {
    "href": "https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345",
    "id": "fee82deba12e4c0fb69c3b09d1f12345",
    "name": "Default"
  }

  Copy to clipboard
  ResourceGroupReference
  resource_group

  href

  Always included*

  string

  The URL for this resource group

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

  Example: https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345

  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

• rules

  Always included*

  The ordered rules for the default network ACL for a VPC. Defaults to two rules which allow all inbound and outbound traffic, respectively. Rules for the default network ACL may be changed, added, or removed.

  NetworkACLRuleItem[]
  rules
  One of
  Change Request Parameter List
  NetworkACLRuleProtocolTCPUDP

• subnets

  Always included*

  The subnets to which this network ACL is attached

  SubnetReference[]

• vpc

  Always included*

  The VPC this network ACL resides in

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs/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

  href

  Always included*

  string

  The URL for this VPC

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/vpcs/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

Status Code

• 200

  The default network ACL was retrieved successfully.

• 404

  The specified VPC could not be found.

Path Parameters

• id

  Required*

  string

  The VPC 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-12-17 and 2024-12-17.

  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

• generation

  Required*

  int32

  The infrastructure generation. For the API behavior documented here, specify 2.

  Allowable values: [2]

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

• accept_routes_from

  Always included*

  The filters specifying the resources that may create routes in this routing table.

  The resources and types of filters supported by this property is expected to expand in the future.

  Possible values: contains only unique items

  Examples:

  View

  [
    {
      "resource_type": "vpn_server"
    }
  ]

  Copy to clipboard
  ResourceFilter[]

• advertise_routes_to

  Always included*

  string[]

  The ingress sources to advertise routes to. Routes in the table with advertise enabled will be advertised to these sources.

  The enumerated values for this property may expand in the future.

  Possible values: [direct_link,transit_gateway]

  Possible values: number of items ≥ 0, contains only unique items, 1 ≤ length ≤ 128, Value must match regular expression ^[a-z][a-z0-9]*(_[a-z0-9]+)*$

  Examples:

  View

  [
    "transit_gateway",
    "direct_link"
  ]

  Copy to clipboard

• created_at

  Always included*

  date-time

  The date and time that this routing table 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 VPC routing table

  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-routing-table:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/r006-6885e83f-03b2-4603-8a86-db2a0f55c840

• href

  Always included*

  string

  The URL for this routing table

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/vpcs/r006-4727d842-f94f-4a2d-824a-9bc9b02c523b/routing_tables/r006-6885e83f-03b2-4603-8a86-db2a0f55c840

• id

  Always included*

  string

  The unique identifier for this routing table

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

  Example: r006-6885e83f-03b2-4603-8a86-db2a0f55c840

• is_default

  Always included*

  boolean

  Indicates whether this is the default routing table for this VPC

• lifecycle_state

  Always included*

  LifecycleState

  The lifecycle state of the routing table

  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 of the default routing table created for this VPC. The name will be a hyphenated list of randomly-selected words at creation, but may be changed.

  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: milled-easy-equine-machines

• resource_group

  Always included*

  The resource group for this routing table

  Examples:

  View

  {
    "href": "https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345",
    "id": "fee82deba12e4c0fb69c3b09d1f12345",
    "name": "Default"
  }

  Copy to clipboard
  ResourceGroupReference
  resource_group

  href

  Always included*

  string

  The URL for this resource group

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

  Example: https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345

  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: [routing_table]

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

• route_direct_link_ingress

  Always included*

  boolean

  Indicates whether this routing table is used to route traffic that originates from Direct Link to this VPC.

  Incoming traffic will be routed according to the routing table with one exception: routes with an action of deliver are treated as drop unless the next_hop is an IP address in a subnet in the route's zone that is able to accept traffic. Therefore, if an incoming packet matches a route with a next_hop of a VPN gateway connection, the packet will be dropped.

• route_internet_ingress

  Always included*

  boolean

  Indicates whether this routing table is used to route traffic that originates from the internet.

  Incoming traffic will be routed according to the routing table with two exceptions:

  • Traffic destined for IP addresses associated with public gateways will not be subject to routes in this routing table.
  • Routes with an action of deliver are treated as drop unless the next_hop is an IP address in a subnet in the route's zone that is able to accept traffic. Therefore, if an incoming packet matches a route with a next_hop of a VPN gateway connection, the packet will be dropped.

• route_transit_gateway_ingress

  Always included*

  boolean

  Indicates whether this routing table is used to route traffic that originates from from Transit Gateway to this VPC.

  Incoming traffic will be routed according to the routing table with one exception: routes with an action of deliver are treated as drop unless the next_hop is an IP address in a subnet in the route's zone that is able to accept traffic. Therefore, if an incoming packet matches a route with a next_hop of a VPN gateway connection, the packet will be dropped.

• route_vpc_zone_ingress

  Always included*

  boolean

  Indicates whether this routing table is used to route traffic that originates from subnets in other zones in this VPC.

  Incoming traffic will be routed according to the routing table with one exception: routes with an action of deliver are treated as drop unless the next_hop is an IP address in a subnet in the route's zone that is able to accept traffic. Therefore, if an incoming packet matches a route with a next_hop of a VPN gateway connection, the packet will be dropped.

• routes

  Always included*

  The routes for the default routing table for this VPC. The table is created with no routes, but routes may be added, changed, or removed with a subsequent request.

  RouteReference[]

• subnets

  Always included*

  The subnets to which this routing table is attached

  SubnetReference[]

Status Code

• 200

  The default routing table was retrieved successfully.

• 404

  The specified VPC could not be found.

Path Parameters

• id

  Required*

  string

  The VPC 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-12-17 and 2024-12-17.

  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

• generation

  Required*

  int32

  The infrastructure generation. For the API behavior documented here, specify 2.

  Allowable values: [2]

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

• crn

  Always included*

  string

  The CRN for this security 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:a/aa2432b1fa4d4ace891e9b80fc104e34::security-group:r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

• href

  Always included*

  string

  The URL for this security group

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/security_groups/r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

• id

  Always included*

  string

  The unique identifier for this security group

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

  Example: r006-be5df5ca-12a0-494b-907e-aa6ec2bfa271

• name

  Always included*

  string

  The name for the default security group for a VPC. The name will be a hyphenated list of randomly-selected words at creation, but may changed.

  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: observant-chip-emphatic-engraver

• resource_group

  Always included*

  The resource group for this security group

  Examples:

  View

  {
    "href": "https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345",
    "id": "fee82deba12e4c0fb69c3b09d1f12345",
    "name": "Default"
  }

  Copy to clipboard
  ResourceGroupReference
  resource_group

  href

  Always included*

  string

  The URL for this resource group

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

  Example: https://resource-controller.cloud.ibm.com/v2/resource_groups/fee82deba12e4c0fb69c3b09d1f12345

  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

• rules

  Always included*

  The rules for the default security group for a VPC. Defaults to allowing all outbound traffic, and allowing all inbound traffic from other interfaces in the VPC's default security group. Rules for the default security group may be changed, added or removed.

  SecurityGroupRule[]
  rules
  One of
  Change Request Parameter List
  SecurityGroupRuleProtocolAll

• targets

  Always included*

  The targets for this security group.

  SecurityGroupTargetReference[]
  targets
  One of
  Change Request Parameter List
  NetworkInterfaceReferenceTargetContext

• vpc

  Always included*

  The VPC this security group resides in

  Examples:

  View

  {
    "crn": "crn:v1:bluemix:public:is:us-south:a/aa2432b1fa4d4ace891e9b80fc104e34::vpc:r006-4727d842-f94f-4a2d-824a-9bc9b02c523b",
    "href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs/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

  href

  Always included*

  string

  The URL for this VPC

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

  Example: https://us-south.iaas.cloud.ibm.com/v1/vpcs/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

Status Code

• 200

  The default security group was retrieved successfully.

• 404

  The specified VPC could not be found.

Path Parameters

• vpc_id

  Required*

  string

  The VPC 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-12-17 and 2024-12-17.

  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

• generation

  Required*

  int32

  The infrastructure generation. For the API behavior documented here, specify 2.

  Allowable values: [2]

• 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

• address_prefixes

  Always included*

  A page of address prefixes for the VPC

  AddressPrefix[]

• first

  Always included*

  A link to the first page of resources

  Examples:

  View

  {
    "href": "https://us-south.iaas.cloud.ibm.com/v1/vpcs/a4e28308-8ee7-46ab-8108-9f881f22bdbf/address_prefixes?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://us-south.iaas.cloud.ibm.com/v1/vpcs/a4e28308-8ee7-46ab-8108-9f881f22bdbf/address_prefixes?start=9d5a91a3e2cbd233b5a5b33436855ed1&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 address prefixes were retrieved successfully.

• 404

  The specified VPC could not be found.

Path Parameters

• vpc_id

  Required*

  string

  The VPC 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-12-17 and 2024-12-17.

  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

• generation

  Required*

  int32

  The infrastructure generation. For the API behavior documented here, specify 2.

  Allowable values: [2]

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

• cidr

  Required*

  string

  The IPv4 range of the address prefix, expressed in CIDR format. The range must not overlap with any existing address prefixes in the VPC or any of the following reserved address ranges:

  • 127.0.0.0/8 (IPv4 loopback addresses)
  • 161.26.0.0/16 (IBM services)
  • 166.8.0.0/14 (Cloud Service Endpoints)
  • 169.254.0.0/16 (IPv4 link-local addresses)
  • 224.0.0.0/4 (IPv4 multicast addresses)

  The prefix length of the address prefix's CIDR must be between /9 (8,388,608 addresses) and /29 (8 addresses).

  Possible values: 9 ≤ length ≤ 18, 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])(\/(3[0-2]|[1-2][0-9]|[0-9]))$

  Example: 10.0.0.0/24

• zone

  Required*

  The zone this address prefix will reside in

  One of

  Change Request Parameter List

  ZoneIdentityByName
  zone

  name

  Required*

  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

• is_default

  boolean

  Indicates whether this will be the default address prefix for this zone in this VPC. If true, the VPC must not have a default address prefix for this zone.

  Default: false

  Example: true

• name

  string

  The name for this address prefix. The name must not be used by another address prefix for the VPC. 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-address-prefix-1