VPC

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP.

This guide provides a brief description of VPC service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

OpenAPI URL

https://vpc.{region}.{environment}.samsungsdscloud.com

Environment and Region List

API Version History

1.3

Multi AZ feature has been added.

Changes

• [Updated] POST /v1/vpcs - The following field has been added to the response.
  • Added : zones, zone_type
• [Updated] GET /v1/vpcs - The following field has been added to the parameters and response.
  • Added : zone, zones, zone_type
• [Updated] GET /v1/vpcs/{vpc_id} - The following field has been added to the response.
  • Added : zones, zone_type
• [Updated] PUT /v1/vpcs/{vpc_id} - When responding, everything except the description field will be removed.
• [Updated] POST /v1/vpcs/{vpc_id}/cidrs - When responding, everything except the cidr field will be removed.
• [Updated] POST /v1/subnets - The following field has been changed to the parameters and response.
  • Added : zones, role, primary_subnet_id, secondary_subnet_ids
  • Changed : The boundary value of type has been changed and added (General → Public changed, Private newly added).
• [Updated] GET /v1/subnets - The following field has been changed to the parameters and response.
  • Added : zones, role, primary_subnet_id
  • Changed : The boundary value of type has been changed and added (General → Public changed, Private newly added).
• [Updated] GET /v1/subnets/{subnet_id} - The following field has been changed to the response.
  • Added : zones, role, primary_subnet_id, secondary_subnet_ids
  • Changed : The boundary value of type has been changed and added (General → Public changed, Private newly added).
• [Updated] PUT /v1/subnets/{subnet_id} - When responding, everything except the description and dhcp_ip_address fields will be removed.
• [Updated] POST /v1/internet-gateways - The following field has been added to the response.
  • Added : multi_zone_enabled
• [Updated] GET /v1/internet-gateways - The following field has been added to the response.
  • Added : multi_zone_enabled
• [Updated] GET /v1/internet-gateways/{internet_gateway_id} - The following field has been added to the response.
  • Added : multi_zone_enabled
• [Updated] PUT /v1/internet-gateways/{internet_gateway_id} - When responding, everything except the description and loggable fields will be removed.
• [Updated] POST /v1/nat-gateways - The following field has been changed to the parameters and response.
  • Added : publicip_ids, multi_zone_enabled, nat_gateway_ip_addresses
  • Removed : publicip_id, nat_gateway_ip_address
• [Updated] GET /v1/nat-gateways - The following field has been changed to the response.
  • Added : multi_zone_enabled, nat_gateway_ip_addresses
  • Removed : nat_gateway_ip_address
• [Updated] GET /v1/nat-gateways/{nat_gateway_id} - The following field has been changed to the response.
  • Added : multi_zone_enabled, nat_gateway_ip_addresses
  • Removed : nat_gateway_ip_address
• [Updated] PUT /v1/nat-gateways/{nat_gateway_id} - When responding, everything except the description field will be removed.
• [Updated] POST /v1/publicips - The following field has been added to the parameters and response.
  • Added : zone
• [Updated] GET /v1/publicips - The following field has been added to the parameters and response.
  • Added : zone
• [Updated] GET /v1/publicips/{publicip_id} - The following field has been added to the response.
  • Added : zone
• [Updated] PUT /v1/publicips/{publicip_id} - When responding, everything except the description field will be removed.
• [Updated] GET /v1/transit-gateways - The following field has been added to the parameters.
  • Added : uplink_zone_state
• [Updated] POST /v1/transit-gateways - The following field has been added to the response.
  • Added : uplink_active_zone, uplink_standby_zone, uplink_zone_state
• [Updated] GET /v1/transit-gateways/{transit_gateway_id} - The following field has been added to the response.
  • Added : uplink_active_zone, uplink_standby_zone, uplink_zone_state
• [Updated] PUT /v1/transit-gateways/{transit_gateway_id} - When responding, everything except the description field will be removed.
• [Updated] POST /v1/transit-gateways/{transit_gateway_id}/firewall-connections - When responding, everything except the firewall_connection_state field will be removed.
• [Updated] DELETE /v1/transit-gateways/{transit_gateway_id}/firewall-connections - When responding, everything except the firewall_connection_state field will be removed.
• [Updated] POST /v1/transit-gateways/{transit_gateway_id}/firewalls - The following field has been added to the parameters and response.
  • Added : uplink_active_zone, uplink_standby_zone, uplink_zone_state
• [Updated] DELETE /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id} - The following field has been added to the response.
  • Added : uplink_active_zone, uplink_standby_zone, uplink_zone_state

1.2

Virtual IP functionality and Transit Gateway Firewall connection capability have been added.

Changes

• [New] GET /v1/subnets/{subnet_id}/vips - API has been added.
• [New] POST /v1/subnets/{subnet_id}/vips - API has been added.
• [New] GET /v1/subnets/{subnet_id}/vips/{vip_id} - API has been added.
• [New] PUT /v1/subnets/{subnet_id}/vips/{vip_id} - API has been added.
• [New] DELETE /v1/subnets/{subnet_id}/vips/{vip_id} - API has been added.
• [New] POST /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports - API has been added.
• [New] DELETE /v1/subnets/{subnet_id}/vips/{vip_id}/connected-ports/{connected_port_id} - API has been added.
• [New] POST /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips - API has been added.
• [New] DELETE /v1/subnets/{subnet_id}/vips/{vip_id}/static-nat-ips/{static_nat_id} - API has been added.
• [New] POST /v1/transit-gateways/{transit_gateway_id}/firewall-connections - API has been added.
• [New] DELETE /v1/transit-gateways/{transit_gateway_id}/firewall-connections - API has been added.
• [New] POST /v1/transit-gateways/{transit_gateway_id}/firewalls - API has been added.
• [New] DELETE /v1/transit-gateways/{transit_gateway_id}/firewalls/{firewall_id} - API has been added.
• [New] POST /v1/vpcs/{vpc_id}/cidrs - API has been added.
• [Updated] GET /v1/vpcs - The following field has been changed to the parameters and response.
  • Added : size, page, cidr_count, cidrs
  • Removed : limit, marker, cidr
• [Updated] GET /v1/vpcs/{vpc_id} - The following field has been changed to the response.
  • Added : cidr_count, cidrs
  • Removed : cidr
• [Updated] : POST /v1/vpcs - The following field has been changed to the response.
  • Added : cidr_count, cidrs
  • Removed : cidr
• [Updated] : PUT /v1/vpcs/{vpc_id} - The following field has been changed to the response.
  • Added : cidr_count, cidrs
  • Removed : cidr
• [Updated] : GET /v1/subnets - The following field has been changed to the parameters and response.
  • Added : size, page
  • Removed : limit, marker
• [Updated] : GET /v1/subnets/{subnet_id} - The following field has been changed to the response.
  • Added : dhcp_ip_addres
• [Updated] : POST /v1/subnets - The following field has been changed to the parameters.
  • Added : gateway_ip_address
• [Updated] : PUT /v1/subnets/{subnet_id} - The following field has been changed to the parameters.
  • Added : dhcp_ip_address
• [Updated] : GET /v1/ports - The following field has been changed to the parameters.
  • Added : attached_resource_types
• [Updated] : GET /v1/ports/{port_id} - The following field has been changed to the response.
  • Added : virtual_ip_addresses
• [Updated] : POST /v1/ports - The following field has been changed to the response.
  • Added : virtual_ip_addresses
• [Updated] : PUT /v1/ports/{port_id} - The following field has been changed to the response.
  • Added : virtual_ip_addresses
• [Updated] : GET /v1/internet-gateways - The following field has been changed to the parameters and response.
  • Added : size, page
  • Removed : limit, marker
• [Updated] : GET /v1/nat-gateways - The following field has been changed to the parameters and response.
  • Added : size, page
  • Removed : limit, marker
• [Updated] : GET /v1/publicips - The following field has been changed to the parameters and response.
  • Added : size, page
  • Removed : limit, marker
• [Updated] : GET /v1/publicips/{publicip_id} - The boundary values for the attached_resource_type field have been expanded.
• [Updated] : GET /v1/vpc-endpoints - The following field has been changed to the parameters and response.
  • Added : size, page
  • Removed : limit, marker
• [Updated] : GET /v1/private-nats - The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.
  • Added : service_type, service_resource_id, service_resource_name
• [Updated] : GET /v1/private-nats/{private_nat_id} - The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.
  • Added : service_type, service_resource_id, service_resource_name
• [Updated] : POST /v1/private-nats - The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.
  • Added : service_type, service_resource_id, service_resource_name
• [Updated] : PUT /v1/private-nats/{private_nat_id} - The following field has been added to the parameters and response. And the fields related to VPC and DCON have been removed.
  • Added : service_type, service_resource_id, service_resource_name
• [Updated] : GET /v1/vpc-peerings/{vpc_peering_id}/routing-rules - The following field has been changed to the parameters.
  • Removed : name
• [Updated] : GET /v1/transit-gateways - The following field has been changed to the parameters and response.
  • Added : firewall_connection_state
• [Updated] : GET /v1/transit-gateways/{transit_gateway_id} - The following field has been changed to the response.
  • Added : firewall_connection_state
• [Updated] : POST /v1/transit-gateways - The following field has been changed to the response.
  • Added : firewall_connection_state
• [Updated] : PUT /v1/transit-gateways/{transit_gateway_id} - The following field has been changed to the response.
  • Added : firewall_connection_state
• [Updated] : GET /v1/transit-gateways/{transit_gateway_id}/routing-rules - The following field has been changed to the parameters and response.
  • Added : rule_type

1.1

VPC API has been released.

Changes

• [New] GET /v1/privatelink-endpoints - API has been added.
• [New] POST /v1/privatelink-endpoints - API has been added.
• [New] GET /v1/privatelink-endpoints/{privatelink_endpoint_id} - API has been added.
• [New] PUT /v1/privatelink-endpoints/{privatelink_endpoint_id} - API has been added.
• [New] DELETE /v1/privatelink-endpoints/{privatelink_endpoint_id} - API has been added.
• [New] PUT /v1/privatelink-endpoints/{privatelink_endpoint_id}/approval - API has been added.
• [New] PUT /v1/privatelink-endpoints/{privatelink_endpoint_id}/connection - API has been added.
• [New] PUT /v1/privatelink-endpoints/{privatelink_endpoint_id}/request - API has been added.
• [New] GET /v1/privatelink-services - API has been added.
• [New] POST /v1/privatelink-services - API has been added.
• [New] GET /v1/privatelink-services/{privatelink_service_id} - API has been added.
• [New] PUT /v1/privatelink-services/{privatelink_service_id} - API has been added.
• [New] DELETE /v1/privatelink-services/{privatelink_service_id} - API has been added.
• [New] GET /v1/privatelink-services/{privatelink_service_id}/connected-endpoints - API has been added.
• [New] PUT /v1/vpc-peerings/{vpc_peering_id}/approval - API has been added.
• [New] GET /v1/subnets/{subnet_id}/sap-secondary-subnets - API has been added.

1.0

VPC API has been released.

Changes

• [New] GET /v1/internet-gateways - API has been added.
• [New] POST /v1/internet-gateways - API has been added.
• [New] GET /v1/internet-gateways/{internet_gateway_id} - API has been added.
• [New] PUT /v1/internet-gateways/{internet_gateway_id} - API has been added.
• [New] DELETE /v1/internet-gateways/{internet_gateway_id} - API has been added.
• [New] GET /v1/nat-gateways - API has been added.
• [New] POST /v1/nat-gateways - API has been added.
• [New] GET /v1/nat-gateways/{nat_gateway_id} - API has been added.
• [New] PUT /v1/nat-gateways/{nat_gateway_id} - API has been added.
• [New] DELETE /v1/nat-gateways/{nat_gateway_id} - API has been added.
• [New] GET /v1/ports - API has been added.
• [New] POST /v1/ports - API has been added.
• [New] GET /v1/ports/{port_id} - API has been added.
• [New] PUT /v1/ports/{port_id} - API has been added.
• [New] DELETE /v1/ports/{port_id} - API has been added.
• [New] GET /v1/private-nats - API has been added.
• [New] POST /v1/private-nats - API has been added.
• [New] GET /v1/private-nats/{private_nat_id} - API has been added.
• [New] PUT /v1/private-nats/{private_nat_id} - API has been added.
• [New] DELETE /v1/private-nats/{private_nat_id} - API has been added.
• [New] GET /v1/private-nats/{private_nat_id}/private-nat-ips - API has been added.
• [New] POST /v1/private-nats/{private_nat_id}/private-nat-ips - API has been added.
• [New] DELETE /v1/private-nats/{private_nat_id}/private-nat-ips/{private_nat_ip_id} - API has been added.
• [New] GET /v1/publicips - API has been added.
• [New] POST /v1/publicips - API has been added.
• [New] GET /v1/publicips/{publicip_id} - API has been added.
• [New] PUT /v1/publicips/{publicip_id} - API has been added.
• [New] DELETE /v1/publicips/{publicip_id} - API has been added.
• [New] GET /v1/subnets - API has been added.
• [New] POST /v1/subnets - API has been added.
• [New] GET /v1/subnets/{subnet_id} - API has been added.
• [New] PUT /v1/subnets/{subnet_id} - API has been added.
• [New] DELETE /v1/subnets/{subnet_id} - API has been added.
• [New] GET /v1/transit-gateways - API has been added.
• [New] POST /v1/transit-gateways - API has been added.
• [New] GET /v1/transit-gateways/{transit_gateway_id} - API has been added.
• [New] PUT /v1/transit-gateways/{transit_gateway_id} - API has been added.
• [New] DELETE /v1/transit-gateways/{transit_gateway_id} - API has been added.
• [New] GET /v1/transit-gateways/{transit_gateway_id}/routing-rules - API has been added.
• [New] POST /v1/transit-gateways/{transit_gateway_id}/routing-rules - API has been added.
• [New] DELETE /v1/transit-gateways/{transit_gateway_id}/routing-rules/{routing_rule_id} - API has been added.
• [New] POST /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules - API has been added.
• [New] DELETE /v1/transit-gateways/{transit_gateway_id}/uplink-routing-rules/{routing_rule_id} - API has been added.
• [New] GET /v1/transit-gateways/{transit_gateway_id}/vpc-connections - API has been added.
• [New] POST /v1/transit-gateways/{transit_gateway_id}/vpc-connections - API has been added.
• [New] DELETE /v1/transit-gateways/{transit_gateway_id}/vpc-connections/{vpc_connection_id} - API has been added.
• [New] GET /v1/vpc-endpoints - API has been added.
• [New] POST /v1/vpc-endpoints - API has been added.
• [New] GET /v1/vpc-endpoints/connectable-resources - API has been added.
• [New] GET /v1/vpc-endpoints/{vpc_endpoint_id} - API has been added.
• [New] PUT /v1/vpc-endpoints/{vpc_endpoint_id} - API has been added.
• [New] DELETE /v1/vpc-endpoints/{vpc_endpoint_id} - API has been added.
• [New] GET /v1/vpc-peerings - API has been added.
• [New] POST /v1/vpc-peerings - API has been added.
• [New] GET /v1/vpc-peerings/{vpc_peering_id} - API has been added.
• [New] PUT /v1/vpc-peerings/{vpc_peering_id} - API has been added.
• [New] DELETE /v1/vpc-peerings/{vpc_peering_id} - API has been added.
• [New] GET /v1/vpc-peerings/{vpc_peering_id}/routing-rules - API has been added.
• [New] POST /v1/vpc-peerings/{vpc_peering_id}/routing-rules - API has been added.
• [New] DELETE /v1/vpc-peerings/{vpc_peering_id}/routing-rules/{routing_rule_id} - API has been added.
• [New] GET /v1/vpcs - API has been added.
• [New] POST /v1/vpcs - API has been added.
• [New] GET /v1/vpcs/{vpc_id} - API has been added.
• [New] PUT /v1/vpcs/{vpc_id} - API has been added.
• [New] DELETE /v1/vpcs/{vpc_id} - API has been added.