Soracom website screenshot

Soracom

Soracom is a global IoT cellular connectivity and platform provider headquartered in Tokyo, founded in 2014, with regional operations in the US (Soracom Global) and EU. The platform pairs multicarrier SIMs (physical, eSIM, iSIM) across 170+ countries with a deep platform of cloud integration services (Beam, Funnel, Funk), data services (Harvest, Lagoon, Query, Orbit), device management (Inventory, Krypton, Endorse, Napter), and network gateways (VPG / Canal / Direct / Door / Gate / Junction / Peek). Soracom exposes the entire stack through a coverage-aware REST API documented at users.soracom.io and maintained as a public OpenAPI 3.0 specification in the soracom-cli GitHub repo.

18 APIs 31 Features
IoTCellularLPWANSIMLoRaWANSigfoxMVNOConnectivityEdgeJapan

APIs

Soracom SIM Management API

Manage Soracom Air for Cellular SIMs (and Subscribers) — list, get, create Arc virtual SIMs, activate/deactivate/suspend/terminate, set group binding, set IMEI lock, view sessio...

Soracom Group Configuration API

Manage Soracom groups and per-service configuration. Groups bind SIMs and devices to namespaced configuration for SoracomAir, SoracomBeam, SoracomFunnel, SoracomFunk, SoracomHar...

Soracom Harvest API

Soracom Harvest is a managed time-series and file store for IoT device payloads. The API retrieves data entries by Subscriber/Device/SigfoxDevice/LoraDevice, lists indexed resou...

Soracom Inventory API

Soracom Inventory provides LwM2M-based registration, object models, resource read/write, observe/notify subscriptions, and remote execution against IoT devices.

Soracom Napter API

Soracom Napter creates on-demand TCP port mappings (with optional TLS) that allow a defined source CIDR to reach a SIM-attached device's TCP port for SSH, HTTP(S), VNC, or RDP-s...

Soracom Event Handler API

Configure event handlers (rules + actions) on SIM, data, and billing events; manage the Credentials Store; and deploy Orbit Soralets (WebAssembly inline payload transforms).

Soracom Virtual Private Gateway API

Provision and manage Soracom Virtual Private Gateways (VPG) including Canal (AWS VPC peering), Direct (AWS Direct Connect), Door (IPSec VPN), Gate (reverse-NAT), Junction (packe...

Soracom Billing API

Retrieve usage charges (monthly bills, daily bill items, per-SIM and per-bill-item summaries), export bills to CSV, manage payment methods, register coupons, manage orders, and ...

Soracom Stats and Diagnostics API

Retrieve cellular data usage statistics (per SIM/subscriber/group/account), API and Napter audit logs, operator error logs, and diagnostic features.

Soracom Auth and Access Management API

Authenticate operators (email/password or AuthKey), issue short-lived API Keys + Tokens, manage operator profile, SAM (Soracom Access Management) users and roles, MFA settings, ...

Soracom Analysis and Query API

Asynchronous SQL query execution over Soracom Query tables (SIM_SESSION_EVENTS, SIM_LOCATIONS, BILLING, and more) and search across SIMs, Inventory devices, and Sigfox devices.

Soracom Lagoon API

Manage Soracom Lagoon (managed Grafana) subscription, plan tier, organization, dashboards, users, licenses, and data sources.

Soracom Air for LoRaWAN API

Manage Soracom Air for LoRaWAN — devices, gateways, network sets, session keys, and group binding for LoRaWAN deployments.

Soracom Air for Sigfox API

Manage Soracom Air for Sigfox devices.

Soracom Cloud Camera Services API

Manage Soracom Cloud Camera Services (SoraCam) devices, livestream URLs, image exports, recording exports, motion events, atomic timestamps, and dedicated cellular pack provisio...

Soracom Batch API

Batch processing — create batch groups, define jobs that invoke API operations across many SIMs or devices, and inspect tasks for status and results.

Soracom Platform API (Aggregate)

The full monolithic Soracom Platform OpenAPI spec — 487 operations across 40 tags covering every Soracom service surface (Sim, Subscriber, Group, Harvest, Inventory, Napter, Eve...

Soracom Sandbox API

Soracom Sandbox API for safely exercising platform workflows. Lets developers create test coupons, fake SIMs, and dummy subscriber records, then run normal API calls against the...

Collections

Soracom API

POSTMAN

Arazzo Workflows

Soracom Audit SIM Session Events

Confirm a SIM exists, read its current session status, and pull its session event history for an audit window.

ARAZZO

Soracom Collect SIM Harvest Data

Confirm a SIM exists, pull its Harvest Data entries, and fall back to the generic Harvest endpoint when empty.

ARAZZO

Soracom Create Monthly Traffic Event Handler

Create an event handler that caps a group's monthly traffic and notifies the operator, then verify it.

ARAZZO

Soracom Deactivate IoT SIM with Guard

Read a SIM, deactivate it only when it is currently active, then confirm the inactive status.

ARAZZO

Soracom Export Monthly Billing CSV

Read a finalized monthly bill, kick off an async detailed-billing CSV export, and poll until the download URL is ready.

ARAZZO

Soracom Provision Group and Attach SIM

Create a SIM group, apply a service configuration, attach an existing SIM, and verify the binding.

ARAZZO

Soracom Register and Activate IoT SIM

Register a physical IoT SIM to the operator, activate it, bind it to a SIM group, and confirm its state.

ARAZZO

Soracom Register and Verify Coupon

List currently registered coupons, register a new coupon code, then re-list to confirm the credit applied.

ARAZZO

Soracom Register Inventory Device to Group

Create a Soracom Inventory device, bind it to an Inventory group, and confirm the binding.

ARAZZO

Soracom Register Subscriber to Group

Register a subscriber by IMSI, activate it, bind it to a group, and confirm its state.

ARAZZO

Soracom Send SMS to Active IoT SIM

Look up a SIM, branch on whether it is active, and send a downlink SMS only when it can receive one.

ARAZZO

Pricing Plans

Soracom Plans Pricing

17 plans

PLANS

Rate Limits

Soracom Rate Limits

0 limits

RATE LIMITS

FinOps

Features

Global multicarrier cellular IoT connectivity spanning 170+ countries on Air for Cellular (plan01s)
Region-specific plans — plan-US, plan-D, plan-K, plan-DU (Japan), planP1 (60+ countries eSIM), planX series, plan-NL1 — for tuned coverage and price
eSIM and iSIM (planP1/planX1/planX2) with multi-IMSI profile management
Soracom Arc — Wireguard-based virtual SIM that joins non-cellular IP devices via soratun
Soracom Air for LoRaWAN and Air for Sigfox — managed LPWAN connectivity
Soracom Beam — cloud proxy for TLS termination and HTTP/MQTT/TCP/UDP/WebSocket protocol conversion
Soracom Funnel — adapter that forwards device payloads to AWS Kinesis/IoT, Azure Event Hubs, GCP Pub/Sub, and more
Soracom Funk — serverless invocation of AWS Lambda / Azure Functions / Google Cloud Functions from device payloads
Soracom Harvest Data — managed time-series store; Harvest Files for binary uploads
Soracom Orbit — inline WebAssembly Soralets that transform device payloads in flight
Soracom Lagoon — managed Grafana-style dashboards (Free / Maker $9.80/mo / Pro $49.80/mo)
Soracom Query — columnar SQL analytics over SIM session, location, and data history
Soracom Napter — on-demand secure remote TCP port mapping into SIM-attached devices
Soracom Inventory — LwM2M device registration, object models, observe/notify, and remote execution
Soracom Endorse — hardware-rooted SIM-based device authentication
Soracom Krypton — credential and certificate provisioning rooted in SIM identity
Virtual Private Gateway (VPG) — Canal (AWS VPC peering), Direct (AWS Direct Connect), Door (IPSec VPN), Gate (reverse-NAT to cloud)
Soracom Junction — Layer-3 packet rule engine (mirror/inspect/redirect) attached to VPG
Soracom Peek — managed packet capture per SIM or per VPG
Soracom Flux — visual workflow automation across Soracom data
Soracom Access Management (SAM) — sub-users, roles, IAM-style policy documents, MFA
Switch-user (cross-operator delegation) for distributors and managed-service providers
Coverage-aware API endpoints — api.soracom.io / jp.api.soracom.io (Japan) and g.api.soracom.io (global)
Soracom Sandbox API at api-sandbox.soracom.io for safe integration testing
Auto-generated soracom CLI built directly from the OpenAPI spec
Official SDKs in Go and Ruby; community SDKs and clients in Java, Swift, JavaScript
Orbit SDKs for Rust, TinyGo, C, and AssemblyScript
Soracom Cloud Camera Services (SoraCam) — managed cameras with livestream, image exports, motion events
Reverse-NAT, IMEI lock, IP whitelisting, and TLS-everywhere posture for industrial IoT
Audit logs for all API calls and all Napter sessions
Direct billing endpoints (/v1/bills) with daily and monthly granularity and CSV export

Semantic Vocabularies

Soracom Context

0 classes · 7 properties

JSON-LD

API Governance Rules

Soracom API Rules

6 rules · 1 errors 5 warnings

SPECTRAL

JSON Structure

Soracom Device Structure

9 properties

JSON STRUCTURE

Soracom Sim Structure

13 properties

JSON STRUCTURE

Example Payloads

Soracom Auth Example

2 fields

EXAMPLE

Soracom Bill Latest Example

2 fields

EXAMPLE

Soracom Harvest Data Example

2 fields

EXAMPLE

Soracom Sim List Example

2 fields

EXAMPLE

Resources

🔗
PostmanWorkspace
PostmanWorkspace
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🌐
Portal
Portal
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🚀
GettingStarted
GettingStarted
📝
Signup
Signup
🔗
Login
Login
💰
Pricing
Pricing
💰
Pricing
Pricing
🟢
StatusPage
StatusPage
📰
Blog
Blog
📄
ChangeLog
ChangeLog
🔗
Press
Press
📜
TermsOfService
TermsOfService
📜
PrivacyPolicy
PrivacyPolicy
💬
Support
Support
🔗
Contact
Contact
🔗
Forums
Forums
🔗
Coverage
Coverage
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
👥
GitHubOrganization
GitHubOrganization
👥
GitHubOrganization
GitHubOrganization
🔗
CLI
CLI
📦
SDKs
SDKs
📦
SDKs
SDKs
📦
SDKs
SDKs
📦
SDKs
SDKs
📦
SDKs
SDKs
📦
SDKs
SDKs
📦
SDKs
SDKs
📦
SDKs
SDKs
🔧
Tools
Tools
🔧
Tools
Tools
🔧
Tools
Tools
🔧
Tools
Tools
🔧
Tools
Tools
🔧
Tools
Tools
🔧
Tools
Tools
🔧
Tools
Tools
💻
CodeExamples
CodeExamples
🔗
Library
Library
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Documentation
Documentation
🔗
Coverage
Coverage
🔗
Plans
Plans
🔗
RateLimits
RateLimits
🔗
FinOps
FinOps
🔗
Vocabulary
Vocabulary
🔗
SpectralRules
SpectralRules

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Soracom Virtual Private Gateway API
  version: 20250903-043502
items:
- info:
    name: VirtualPrivateGateway
    type: folder
  items:
  - info:
      name: List Virtual Private Gateways
      type: http
    http:
      method: GET
      url: https://api.soracom.io/v1/virtual_private_gateways
      params:
      - name: tag_name
        value: ''
        type: query
        description: Tag name of the VPG. Filters through all VPGs that exactly match the tag name. When tag_name is specified,
          tag_value is required.
      - name: tag_value
        value: ''
        type: query
        description: Tag value of the VPG.
      - name: tag_value_match_mode
        value: ''
        type: query
        description: Tag match mode.
      - name: limit
        value: ''
        type: query
        description: Maximum number of results per response page.
      - name: last_evaluated_key
        value: ''
        type: query
        description: The last VPG ID retrieved on the current page. By specifying this parameter, you can continue to retrieve
          the list from the next VPG onward.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Returns a list of VPGs.
  - info:
      name: Create Virtual Private Gateway
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Create a new VPG.
  - info:
      name: Get Virtual Private Gateway
      type: http
    http:
      method: GET
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Retrieves information about the specified VPG.
  - info:
      name: Create routing table entry
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/customer_routes
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Creates a routing table entry for the specified VPG.
  - info:
      name: Update routing table entry
      type: http
    http:
      method: PUT
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/customer_routes/:route_id
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      - name: route_id
        value: ''
        type: path
        description: Target route ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Updates a routing table entry for the specified VPG.
  - info:
      name: Delete routing table entry
      type: http
    http:
      method: DELETE
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/customer_routes/:route_id
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      - name: route_id
        value: ''
        type: path
        description: Target route ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Deletes a routing table entry from the specified VPG.
  - info:
      name: Enable the fixed global IP address option for the VPG
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses
      params:
      - name: vpg_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Enables the fixed global IP address option for the VPG.
  - info:
      name: Disable the fixed global IP address option for the VPG
      type: http
    http:
      method: DELETE
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/fixed_public_ip_addresses
      params:
      - name: vpg_id
        value: ''
        type: path
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Disables the fixed global IP address option for the VPG.
  - info:
      name: Close SORACOM Gate.
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/close
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Close Soracom Gate on the specified VPG.
  - info:
      name: Disables Soracom Gate's privacy separator feature on the specified VPG
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/disable_privacy_separator
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Disables Soracom Gate's privacy separator feature on the specified VPG and enables the Gate D2D feature.
  - info:
      name: Enables Soracom Gate privacy separator feature on the specified VPG
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/enable_privacy_separator
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Enables Soracom Gate's privacy separator feature on the specified VPG and disables the Gate D2D feature.
  - info:
      name: Open Soracom Gate
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/open
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Open Soracom Gate on the specified VPG.
  - info:
      name: List VPG Gate Peers
      type: http
    http:
      method: GET
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/peers
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: List Gate Peers registered in the Virtual Private Gateway.
  - info:
      name: Register VPG Gate Peer
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/peers
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Register a host as a Gate Peer in the Virtual Private Gateway.
  - info:
      name: Unregister VPG Gate Peer
      type: http
    http:
      method: DELETE
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/peers/:outer_ip_address
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      - name: outer_ip_address
        value: ''
        type: path
        description: ID of the target node.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Unregister a Gate Peer from the Virtual Private Gateway.
  - info:
      name: Disable SIM-Based Routing
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/routing/static/sims/disable
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Disables SIM-Based Routing.
  - info:
      name: Enable SIM-Based Routing
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/routing/static/sims/enable
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Enables SIM-Based Routing.
  - info:
      name: Associate a router's LAN IP address range with its SIM ID
      type: http
    http:
      method: PUT
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/routing/static/sims/routes
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Associates a router's LAN IP address range with its SIM ID.
  - info:
      name: Set VXLAN ID for Gate
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/gate/set_vxlan_id
      params:
      - name: vpg_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Set VXLAN ID for Gate.
  - info:
      name: List VPG IP address map entries
      type: http
    http:
      method: GET
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/ip_address_map
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      - name: limit
        value: ''
        type: query
        description: The maximum number of IP address map entries to retrieve. The response may contain fewer entries than
          the specified value.
      - name: last_evaluated_key
        value: ''
        type: query
        description: The last IP address retrieved in the previous page. Use this parameter to retrieve the next page of IP
          address map entries.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: 'Retrieves the list of IP address map entries for the specified VPG.

      '
  - info:
      name: Adds or updates an entry in VPG IP address map
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/ip_address_map
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: 'Adds or updates an IP address map entry for the specified VPG.


      **Warning**: The [VirtualPrivateGateway:listVirtualPrivateGatewayIpAddressMapEntries API](#/VirtualPrivateGateway/listVirtualPrivateGatewayIpAddressMapEntries)
      response includes entries that are automatically assigned to Gate Peers and the VPG, but these cannot be added or updated
      using the VirtualPrivateGateway:putVirtualPrivateGatewayIpAddressMapEntry API.

      '
  - info:
      name: Delete VPG IP address map entry
      type: http
    http:
      method: DELETE
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/ip_address_map/:key
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      - name: key
        value: ''
        type: path
        description: Identifier of the IP address map entry to delete (IMSI of the IoT SIM).
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: 'Deletes an entry from the IP address map of the specified VPG.


      **Warning**: The [VirtualPrivateGateway:listVirtualPrivateGatewayIpAddressMapEntries API](#/VirtualPrivateGateway/listVirtualPrivateGatewayIpAddressMapEntries)
      response includes automatically assigned entries for Gate Peers and the VPG. These entries cannot be deleted using the
      VirtualPrivateGateway:deleteVirtualPrivateGatewayIpAddressMapEntry API.

      '
  - info:
      name: Adds node in the list of Junction mirroring peers
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/mirroring/peers
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Adds node in the list of Junction mirroring peers.
  - info:
      name: Updates a Junction mirroring peer
      type: http
    http:
      method: PUT
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/mirroring/peers/:ipaddr
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      - name: ipaddr
        value: ''
        type: path
        description: Mirroring peer IP address
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Updates a Junction mirroring peer.
  - info:
      name: Remove peer from the list of Junction mirroring peers
      type: http
    http:
      method: DELETE
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/mirroring/peers/:ipaddr
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      - name: ipaddr
        value: ''
        type: path
        description: IP address of mirroring peer
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Remove peer from the list of Junction mirroring peers.
  - info:
      name: Sets configuration for Junction inspection feature
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/set_inspection
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Sets configuration for Junction inspection feature.
  - info:
      name: Sets configuration for Junction redirection feature
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/set_redirection
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Sets configuration for Junction redirection feature.
  - info:
      name: Unset configuration for Junction inspection feature
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/unset_inspection
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Unset configuration for Junction inspection feature.
  - info:
      name: Unset configuration for Junction redirection feature
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/junction/unset_redirection
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Unset configuration for Junction redirection feature.
  - info:
      name: List Packet Capture Sessions associated with the VPG
      type: http
    http:
      method: GET
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/packet_capture_sessions
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      - name: last_evaluated_key
        value: ''
        type: query
        description: ID of the last packet capture session in the previous page. By specifying this parameter, you can continue
          to retrieve the list from the next packet capture session onward.
      - name: limit
        value: ''
        type: query
        description: Max number of results in a response.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: List packet capture sessions associated with the VPG.
  - info:
      name: Create a packet capture session associated with the VPG
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/packet_capture_sessions
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Create a packet capture session associated with the VPG.
  - info:
      name: Get a packet capture session associated with the VPG
      type: http
    http:
      method: GET
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      - name: session_id
        value: ''
        type: path
        description: Packet capture session ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Get a packet capture session associated with the VPG.
  - info:
      name: Delete a packet capture session associated with the VPG
      type: http
    http:
      method: DELETE
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      - name: session_id
        value: ''
        type: path
        description: Packet capture session ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Delete a packet capture session associated with the VPG.
  - info:
      name: Stop a packet capture session associated with the VPG
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/packet_capture_sessions/:session_id/stop
      params:
      - name: vpg_id
        value: ''
        type: path
        description: VPG ID
      - name: session_id
        value: ''
        type: path
        description: Packet capture session ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Stop a packet capture session associated with the VPG.
  - info:
      name: Sets Virtual Private Gateway outbound routing filter
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/set_routing_filter
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Sets Virtual Private Gateway outbound routing filter.
  - info:
      name: Update VPG tags
      type: http
    http:
      method: PUT
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/tags
      params:
      - name: vpg_id
        value: ''
        type: path
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Adds/updates tags of the specified VPG.
  - info:
      name: Delete a VPG Tag
      type: http
    http:
      method: DELETE
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/tags/:tag_name
      params:
      - name: vpg_id
        value: ''
        type: path
      - name: tag_name
        value: ''
        type: path
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Deletes a tag from the specified VPG.
  - info:
      name: Terminate Virtual Private Gateway
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/terminate
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Terminates the specified VPG.
  - info:
      name: Create transit gateway peering connection
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Creates a transit gateway peering connection for the specified VPG.
  - info:
      name: Delete transit gateway peering connection
      type: http
    http:
      method: DELETE
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/transit_gateway_peering_connections/:soracom_tgw_peering_attachment_id
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      - name: soracom_tgw_peering_attachment_id
        value: ''
        type: path
        description: Transit gateway peering connection ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Deletes a transit gateway peering connection from the specified VPG.
  - info:
      name: Create transit gateway VPC attachment
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Creates a transit gateway VPC attachment for the specified VPG.
  - info:
      name: Delete transit gateway VPC attachment
      type: http
    http:
      method: DELETE
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      - name: customer_tgw_vpc_attachment_id
        value: ''
        type: path
        description: Transit gateway VPC attachment ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Deletes a transit gateway VPC attachment from the specified VPG.
  - info:
      name: Accept transit gateway VPC attachment connection request
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/transit_gateway_vpc_attachments/:customer_tgw_vpc_attachment_id/accept
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      - name: customer_tgw_vpc_attachment_id
        value: ''
        type: path
        description: Transit gateway VPC attachment ID
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Accepts the specified transit gateway VPC attachment connection request.
  - info:
      name: Create VPC Peering Connection
      type: http
    http:
      method: POST
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/vpc_peering_connections
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      body:
        type: json
        data: '{}'
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Creates a VPC peering connection for the specified VPG.
  - info:
      name: Delete VPC Peering Connection
      type: http
    http:
      method: DELETE
      url: https://api.soracom.io/v1/virtual_private_gateways/:vpg_id/vpc_peering_connections/:pcx_id
      params:
      - name: vpg_id
        value: ''
        type: path
        description: Target VPG ID.
      - name: pcx_id
        value: ''
        type: path
        description: VPC peering connection ID to be deleted.
      auth:
        type: apikey
        key: X-Soracom-API-Key
        value: '{{X-Soracom-API-Key}}'
        placement: header
    docs: Deletes the specified VPC peering connection.
bundled: true