Soracom VirtualPrivateGateway API
- [Virtual Private Gateway (VPG)](/en/docs/vpg/) (Canal / Direct / Door / Gate)- [Soracom Junction](/en/docs/junction/)- [Soracom Peek](/en/docs/peek/)
Soracom VirtualPrivateGateway API is one of 45 APIs that Soracom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include VirtualPrivateGateway. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.
This API exposes 45 operations across 37 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version 20250903-043502.
Requests are made against 2 base URLs: https://api.soracom.io/v1, https://g.api.soracom.io/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Soracom VirtualPrivateGateway API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-Soracom-API-Key (api_key).
An API key is passed in the header as X-Soracom-Token (api_token).
api_key— API key for authentication. Obtain this from the Soracom User Console or via the Auth API. Required in combination with an API token for all authenticated requ…api_token— API token for authentication. This token has an expiration time and must be refreshed periodically. Required in combination with an API key for all authenticat…
Paths & Operations 45
Across 37 paths, the API surfaces 45 operations — 10 DELETE, 6 GET, 25 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
- [Virtual Private Gateway (VPG)](/en/docs/vpg/) (Canal / Direct / Door / Gate) - [Soracom Junction](/en/docs/junction/) - [Soracom Peek](/en/docs/peek/)
Schemas 50
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are VirtualPrivateGateway (38 properties), TransitGatewayPeeringConnection (9 properties), PacketCaptureSession (9 properties), TransitGatewayVpcAttachment (8 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Soracom 12
Other APIs Soracom publishes across the network.
This is an independent, third-party profile of Soracom VirtualPrivateGateway API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.