Soracom

Soracom VirtualPrivateGateway API

- [Virtual Private Gateway (VPG)](/en/docs/vpg/) (Canal / Direct / Door / Gate) - [Soracom Junction](/en/docs/junction/) - [Soracom Peek](/en/docs/peek/)

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 45

GET /virtual_private_gateways List Virtual Private Gateways #
POST /virtual_private_gateways Create Virtual Private Gateway #
GET /virtual_private_gateways/{vpg_id} Get Virtual Private Gateway #
POST /virtual_private_gateways/{vpg_id}/customer_routes Create routing table entry #
DELETE /virtual_private_gateways/{vpg_id}/customer_routes/{route_id} Delete routing table entry #
PUT /virtual_private_gateways/{vpg_id}/customer_routes/{route_id} Update routing table entry #
DELETE /virtual_private_gateways/{vpg_id}/fixed_public_ip_addresses Disable the fixed global IP address option for the VPG #
POST /virtual_private_gateways/{vpg_id}/fixed_public_ip_addresses Enable the fixed global IP address option for the VPG #
POST /virtual_private_gateways/{vpg_id}/gate/close Close SORACOM Gate #
POST /virtual_private_gateways/{vpg_id}/gate/disable_privacy_separator Disables Soracom Gate's privacy separator feature on the specified VPG #
POST /virtual_private_gateways/{vpg_id}/gate/enable_privacy_separator Enables Soracom Gate privacy separator feature on the specified VPG #
POST /virtual_private_gateways/{vpg_id}/gate/open Open Soracom Gate #
GET /virtual_private_gateways/{vpg_id}/gate/peers List VPG Gate Peers #
POST /virtual_private_gateways/{vpg_id}/gate/peers Register VPG Gate Peer #
DELETE /virtual_private_gateways/{vpg_id}/gate/peers/{outer_ip_address} Unregister VPG Gate Peer #
POST /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/disable Disable SIM-Based Routing #
POST /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/enable Enable SIM-Based Routing #
PUT /virtual_private_gateways/{vpg_id}/gate/routing/static/sims/routes Associate a router's LAN IP address range with its SIM ID #
POST /virtual_private_gateways/{vpg_id}/gate/set_vxlan_id Set VXLAN ID for Gate #
GET /virtual_private_gateways/{vpg_id}/ip_address_map List VPG IP address map entries #
POST /virtual_private_gateways/{vpg_id}/ip_address_map Adds or updates an entry in VPG IP address map #
DELETE /virtual_private_gateways/{vpg_id}/ip_address_map/{key} Delete VPG IP address map entry #
POST /virtual_private_gateways/{vpg_id}/junction/mirroring/peers Adds node in the list of Junction mirroring peers #
DELETE /virtual_private_gateways/{vpg_id}/junction/mirroring/peers/{ipaddr} Remove peer from the list of Junction mirroring peers #
PUT /virtual_private_gateways/{vpg_id}/junction/mirroring/peers/{ipaddr} Updates a Junction mirroring peer #
POST /virtual_private_gateways/{vpg_id}/junction/set_inspection Sets configuration for Junction inspection feature #
POST /virtual_private_gateways/{vpg_id}/junction/set_redirection Sets configuration for Junction redirection feature #
POST /virtual_private_gateways/{vpg_id}/junction/unset_inspection Unset configuration for Junction inspection feature #
POST /virtual_private_gateways/{vpg_id}/junction/unset_redirection Unset configuration for Junction redirection feature #
GET /virtual_private_gateways/{vpg_id}/packet_capture_sessions List Packet Capture Sessions associated with the VPG #
POST /virtual_private_gateways/{vpg_id}/packet_capture_sessions Create a packet capture session associated with the VPG #
DELETE /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id} Delete a packet capture session associated with the VPG #
GET /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id} Get a packet capture session associated with the VPG #
POST /virtual_private_gateways/{vpg_id}/packet_capture_sessions/{session_id}/stop Stop a packet capture session associated with the VPG #
POST /virtual_private_gateways/{vpg_id}/set_routing_filter Sets Virtual Private Gateway outbound routing filter #
PUT /virtual_private_gateways/{vpg_id}/tags Update VPG tags #
DELETE /virtual_private_gateways/{vpg_id}/tags/{tag_name} Delete a VPG Tag #
POST /virtual_private_gateways/{vpg_id}/terminate Terminate Virtual Private Gateway #
POST /virtual_private_gateways/{vpg_id}/transit_gateway_peering_connections Create transit gateway peering connection #
DELETE /virtual_private_gateways/{vpg_id}/transit_gateway_peering_connections/{soracom_tgw_peering_attachment_id} Delete transit gateway peering connection #
POST /virtual_private_gateways/{vpg_id}/transit_gateway_vpc_attachments Create transit gateway VPC attachment #
DELETE /virtual_private_gateways/{vpg_id}/transit_gateway_vpc_attachments/{customer_tgw_vpc_attachment_id} Delete transit gateway VPC attachment #
POST /virtual_private_gateways/{vpg_id}/transit_gateway_vpc_attachments/{customer_tgw_vpc_attachment_id}/accept Accept transit gateway VPC attachment connection request #
POST /virtual_private_gateways/{vpg_id}/vpc_peering_connections Create VPC Peering Connection #
DELETE /virtual_private_gateways/{vpg_id}/vpc_peering_connections/{pcx_id} Delete VPC Peering Connection #

Documentation

📖
Documentation
https://developers.soracom.io/en/docs/harvest/
📖
Documentation
https://developers.soracom.io/en/docs/inventory/
📖
Documentation
https://developers.soracom.io/en/docs/napter/
📖
Documentation
https://developers.soracom.io/en/docs/event-handler/
📖
Documentation
https://developers.soracom.io/en/docs/vpg/
📖
Documentation
https://developers.soracom.io/en/docs/query/
📖
Documentation
https://developers.soracom.io/en/docs/air-for-lorawan/
📖
Documentation
https://developers.soracom.io/en/docs/air-for-sigfox/
📖
Documentation
https://users.soracom.io/ja-jp/tools/api/reference/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/openapi/soracom-virtualprivategateway-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-schema/soracom-data-entry-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-schema/soracom-device-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-structure/soracom-device-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-schema/soracom-port-mapping-schema.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/examples/soracom-harvest-data-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/examples/soracom-napter-create-example.json
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-ld/soracom-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/soracom-virtualprivategateway-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

soracom-virtualprivategateway-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Soracom API v1
  title: Soracom Virtual Private Gateway API
  version: 20250903-043502
servers:
- description: Japan coverage production API endpoint
  url: https://api.soracom.io/v1
- description: Global coverage production API endpoint
  url: https://g.api.soracom.io/v1
tags:


# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/openapi/soracom-virtualprivategateway-api-openapi.yml