Virtual Private Cloud API

Introduction With the IBM Cloud® Virtual Private Cloud VPC API, you can programmatically provision and manage resources that are part of the IBM VPC Infrastructure as a Service IaaS across compute, st

MethodPathSummary
List backup policies
Create a backup policy
List jobs for a backup policy
Retrieve a backup policy job
List plans for a backup policy
Create a plan for a backup policy
Delete a backup policy plan
Retrieve a backup policy plan
Update a backup policy plan
Delete a backup policy
Retrieve a backup policy
Update a backup policy
List capacities for bare metal servers
List bare metal server profiles
Retrieve a bare metal server profile
List bare metal servers
Create a bare metal server
Retrieve the console WebSocket for a bare metal server
Create a console access token for a bare metal server
List disks on a bare metal server
Retrieve a bare metal server disk
Update a bare metal server disk
List network attachments on a bare metal server
Create a network attachment on a bare metal server
Delete a bare metal server network attachment
Retrieve a bare metal server network attachment
Update a bare metal server network attachment
List network interfaces on a bare metal server
Create a network interface on a bare metal server
Delete a bare metal server network interface
Retrieve a bare metal server network interface
Update a bare metal server network interface
List floating IPs associated with a bare metal server network interface
Disassociate a floating IP from a bare metal server network interface
Retrieve associated floating IP
Associate a floating IP with a bare metal server network interface
List the primary reserved IP for a bare metal server network interface
Retrieve the primary reserved IP
Delete a bare metal server
Retrieve a bare metal server
Update a bare metal server
Update firmware for a bare metal server
Retrieve initialization configuration for a bare metal server
Reinitialize a bare metal server
Restart a bare metal server
Start a bare metal server
Stop a bare metal server
List cluster network profiles
Retrieve a cluster network profile
List cluster networks
Create a cluster network
List cluster network interfaces
Create a cluster network interface
Delete a cluster network interface
Retrieve a cluster network interface
Update a cluster network interface
List cluster network subnets
Create a cluster network subnet
List cluster network subnet reserved IPs
Create a cluster network subnet reserved IP
Delete a cluster network subnet reserved IP
Retrieve a cluster network subnet reserved IP
Update a cluster network subnet reserved IP
Delete a cluster network subnet
Retrieve a cluster network subnet
Update a cluster network subnet
Delete a cluster network
Retrieve a cluster network
Update a cluster
List dedicated host groups
Create a dedicated host group
Delete a dedicated host group
Retrieve a dedicated host group
Update a dedicated host group
List dedicated host profiles
Retrieve a dedicated host profile
List dedicated hosts
Create a dedicated host
List disks on a dedicated host
Retrieve a dedicated host disk
Update a dedicated host disk
Delete a dedicated host
Retrieve a dedicated host
Update a dedicated host
List endpoint gateways
Create an endpoint gateway
List reserved IPs bound to an endpoint gateway
Unbind a reserved IP from an endpoint gateway
Retrieve a reserved IP bound to an endpoint gateway
Bind a reserved IP to an endpoint gateway
List resource bindings for an endpoint gateway
Create a resource binding for an endpoint gateway
Delete a resource binding from an endpoint gateway
Retrieve an endpoint gateway resource binding
Update an endpoint gateway resource binding
Delete an endpoint gateway
Retrieve an endpoint gateway
Update an endpoint gateway
List floating IPs
Reserve a floating IP
Delete a floating IP
Retrieve a floating IP
Update a floating IP
List flow log collectors
Create a flow log collector
Delete a flow log collector
Retrieve a flow log collector
Update a flow log collector
List regions
Retrieve a region
List zones in a region
Retrieve a zone
List images
Create an image
Delete an image
Retrieve an image
Update an image
List bare metal server profiles compatible with an image
Deprecate an image
List instance profiles compatible with an image
Obsolete an image
List export jobs for an image
Create an export job for an image
Delete an image export job
Retrieve an image export job
Update an image export job
List operating systems
Retrieve an operating system
List instance groups
Create an instance group
Delete an instance group
Retrieve an instance group
Update an instance group
Delete an instance group load balancer
List managers for an instance group
Create a manager for an instance group
Delete an instance group manager
Retrieve an instance group manager
Update an instance group manager
List actions for an instance group manager
Create an instance group manager action
Delete specified instance group manager action
Retrieve specified instance group manager action
Update specified instance group manager action
List policies for an instance group manager
Create a policy for an instance group manager
Delete an instance group manager policy
Retrieve an instance group manager policy
Update an instance group manager policy
Delete memberships from an instance group
List memberships for an instance group
Delete an instance group membership
Retrieve an instance group membership
Update an instance group membership
List instance templates
Create an instance template
Delete an instance template
Retrieve an instance template
Update an instance template
List instance profiles
Retrieve an instance profile
List instances
Create an instance
Delete an instance
Retrieve an instance
Update an instance
Retrieve initialization configuration for an instance
Reinitialize an instance
Create an instance action
List cluster network attachments on an instance
Create a cluster network attachment
Delete an instance cluster network attachment
Retrieve an instance cluster network attachment
Update an instance cluster network attachment
Retrieve the console WebSocket for an instance
Create a console access token for an instance
List disks on an instance
Retrieve an instance disk
Update an instance disk
List network attachments on an instance
Create a network attachment on an instance
Delete an instance network attachment
Retrieve an instance network attachment
Update an instance network attachment
List network interfaces on an instance
Create a network interface on an instance
Delete an instance network interface
Retrieve an instance network interface
Update an instance network interface
List floating IPs associated with an instance network interface
Disassociate a floating IP from an instance network interface
Retrieve associated floating IP
Associate a floating IP with an instance network interface
List the primary reserved IP for an instance network interface
Retrieve the primary reserved IP
List instance software attachments associated with an instance
Retrieve an instance software attachment
Update an instance software attachment
List volumes attachments on an instance
Create a volume attachment on an instance
Delete a volume attachment
Retrieve a volume attachment
Update a volume attachment
List keys
Create a key
Delete a key
Retrieve a key
Update a key
List load balancer profiles
Retrieve a load balancer profile
List load balancers
Create a load balancer
Delete a load balancer
Retrieve a load balancer
Update a load balancer
List statistics of a load balancer
List listeners for a load balancer
Create a listener for a load balancer
Delete a load balancer listener
Retrieve a load balancer listener
Update a load balancer listener
List policies for a load balancer listener
Create a policy for a load balancer listener
Delete a load balancer listener policy
Retrieve a load balancer listener policy
Update a load balancer listener policy
List rules of a load balancer listener policy
Create a rule for a load balancer listener policy
Delete a load balancer listener policy rule
Retrieve a load balancer listener policy rule
Update a load balancer listener policy rule
List pools of a load balancer
Create a load balancer pool
Delete a load balancer pool
Retrieve a load balancer pool
Update a load balancer pool
List members of a load balancer pool
Create a member in a load balancer pool
Replace load balancer pool members
Delete a load balancer pool member
Retrieve a load balancer pool member
Update a load balancer pool member
List network ACLs
Create a network ACL
Delete a network ACL
Retrieve a network ACL
Update a network ACL
List rules for a network ACL
Create a rule for a network ACL
Delete a network ACL rule
Retrieve a network ACL rule
Update a network ACL rule
List placement groups
Create a placement group
Delete a placement group
Retrieve a placement group
Update a placement group
List private path service gateways
Create a private path service gateway
Delete a private path service gateway
Retrieve a private path service gateway
Update a private path service gateway
List account policies for a private path service gateway
Create an account policy for a private path service gateway
Delete an account policy for a private path service gateway
Retrieve an account policy for a private path service gateway
Update an account policy for a private path service gateway
List endpoint gateway bindings for a private path service gateway
Retrieve an endpoint gateway binding for a private path service gateway
Deny an endpoint gateway binding for a private path service gateway
Permit an endpoint gateway binding for a private path service gateway
Publish a private path service gateway
Revoke access to a private path service gateway for an account
Unpublish a private path service gateway
List public address ranges
Create a public address range
Delete a public address range
Retrieve a public address range
Update a public address range
List public gateways
Create a public gateway
Delete a public gateway
Retrieve a public gateway
Update a public gateway
List reservations
Create a reservation
Delete a reservation
Retrieve a reservation
Update a reservation
Activate a reservation
List security groups
Create a security group
Delete a security group
Retrieve a security group
Update a security group
List rules in a security group
Create a rule for a security group
Delete a security group rule
Retrieve a security group rule
Update a security group rule
List targets associated with a security group
Remove a target from a security group
Retrieve a security group target
Add a target to a security group
List file share profiles
Retrieve a file share profile
List file shares
Create a file share
Delete a file share
Retrieve a file share
Update a file share
List accessor bindings for a file share
Delete a file share accessor binding
Retrieve a file share accessor binding
Failover to replica file share
List mount targets for a file share
Create a mount target for a file share
Delete a file share mount target
Retrieve a file share mount target
Update a file share mount target
List file share snapshots
Create a snapshot for a file share
Delete a share snapshot
Retrieve a share snapshot
Update a share snapshot
Split the source file share from a replica file share
Retrieve the source file share for a replica file share
List snapshot consistency groups
Create a snapshot consistency group
Delete a snapshot consistency group
Retrieve a snapshot consistency group
Update a snapshot consistency group
Delete a filtered collection of snapshots
List snapshots
Create a snapshot
Delete a snapshot
Retrieve a snapshot
Update a snapshot
List clones for a snapshot
Delete a snapshot clone
Retrieve a snapshot clone
Create a clone for a snapshot
List instance profiles compatible with a snapshot
List subnets
Create a subnet
Delete a subnet
Retrieve a subnet
Update a subnet
Retrieve a subnet's attached network ACL
Replace the network ACL for a subnet
Detach a public gateway from a subnet
Retrieve a subnet's attached public gateway
Attach a public gateway to a subnet
Retrieve a subnet's attached routing table
Replace the routing table for a subnet
List reserved IPs in a subnet
Reserve an IP in a subnet
Delete a reserved IP
Retrieve a reserved IP
Update a reserved IP
List virtual network interfaces
Create a virtual network interface
Delete a virtual network interface
Retrieve a virtual network interface
Update a virtual network interface
List floating IPs associated with a virtual network interface
Disassociate a floating IP from a virtual network interface
Retrieve associated floating IP
Add an association between a floating IP and a virtual network interface
List reserved IPs bound to a virtual network interface
Unbind a reserved IP from a virtual network interface
Retrieve bound reserved IP
Bind a reserved IP to a virtual network interface
List volume profiles
Retrieve a volume profile
List volumes
Create a volume
Delete a volume
Retrieve a volume
Update a volume
List instance profiles compatible with a volume
List jobs for a volume
Create a job for a volume
Delete a volume job
Retrieve a volume job
Update a volume job
Cancel a queued or running volume job
List VPCs
Create a VPC
Delete a VPC
Retrieve a VPC
Update a VPC
Retrieve a VPC's default network ACL
Retrieve a VPC's default routing table
Retrieve a VPC's default security group
List address prefixes for a VPC
Create an address prefix for a VPC
Delete an address prefix
Retrieve an address prefix
Update an address prefix
List DNS resolution bindings for a VPC
Create a DNS resolution binding
Delete a DNS resolution binding
Retrieve a DNS resolution binding
Update a DNS resolution binding
List routes in a VPC's default routing table
Create a route in a VPC's default routing table
Delete a VPC route
Retrieve a VPC route
Update a VPC route
List routing tables for a VPC
Create a routing table for a VPC
Delete a VPC routing table
Retrieve a VPC routing table
Update a VPC routing table
List routes in a VPC routing table
Create a route in a VPC routing table
Delete a VPC routing table route
Retrieve a VPC routing table route
Update a VPC routing table route
List IKE policies
Create an IKE policy
Delete an IKE policy
Retrieve an IKE policy
Update an IKE policy
List VPN gateway connections that use a specified IKE policy
List IPsec policies
Create an IPsec policy
Delete an IPsec policy
Retrieve an IPsec policy
Update an IPsec policy
List VPN gateway connections that use a specified IPsec policy
List VPN gateways
Create a VPN gateway
Delete a VPN gateway
Retrieve a VPN gateway
Update a VPN gateway
List advertised CIDRs for a VPN gateway
Remove an advertised CIDR from a VPN gateway
Check if the specified advertised CIDR exists on a VPN gateway
Set an advertised CIDR on a VPN gateway
List connections of a VPN gateway
Create a connection for a VPN gateway
Delete a VPN gateway connection
Retrieve a VPN gateway connection
Update a VPN gateway connection
List local CIDRs for a VPN gateway connection
Remove a local CIDR from a VPN gateway connection
Check if the specified local CIDR exists on a VPN gateway connection
Set a local CIDR on a VPN gateway connection
List peer CIDRs for a VPN gateway connection
Remove a peer CIDR from a VPN gateway connection
Check if the specified peer CIDR exists on a VPN gateway connection
Set a peer CIDR on a VPN gateway connection
List VPN gateway service connections
Retrieve a VPN gateway service connection
List VPN servers
Create a VPN server
Delete a VPN server
Retrieve a VPN server
Update a VPN server
Retrieve client configuration
List VPN clients for a VPN server
Delete a VPN client
Retrieve a VPN client
Disconnect a VPN client
List VPN routes for a VPN server
Create a VPN route for a VPN server
Delete a VPN route
Retrieve a VPN route
Update a VPN route