Soracom

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 session events, manage SIM profiles for multi-IMSI eSIM, and read cell-tower location info.

GitHub OpenAPI
Business capability
SIM & eSIM Lifecycle Management BC-2640.20

Operations 45

GET /sims List SIMs #
POST /sims Creates a new virtual SIM/Subscriber #
GET /sims/{sim_id} Gets information about the IoT SIM #
POST /sims/{sim_id}/activate Activate SIM #
DELETE /sims/{sim_id}/credentials/arc (DEPRECATED) Removes the credentials for Arc from a SIM #
POST /sims/{sim_id}/credentials/arc (DEPRECATED) Attaches the credentials for Arc to a SIM #
PUT /sims/{sim_id}/credentials/arc Renew the credentials for Arc to a SIM #
GET /sims/{sim_id}/data Get data sent from a SIM to Harvest Data #
POST /sims/{sim_id}/deactivate Deactivate SIM #
POST /sims/{sim_id}/delete_session Delete and reconnect the Session #
POST /sims/{sim_id}/disable_termination Disables termination of the SIM #
POST /sims/{sim_id}/downlink/http Send an HTTP request to a device using an IoT SIM #
POST /sims/{sim_id}/downlink/ping Sends ping requests to a SIM #
POST /sims/{sim_id}/downlink/rtsp Send a command to a RTSP stream to a device using an IoT SIM #
POST /sims/{sim_id}/downlink/ssh Connect to a device using an IoT SIM via SSH and execute a specified command #
POST /sims/{sim_id}/downlink/tcp Connect to a device using an IoT SIM via TCP and send/receive data #
POST /sims/{sim_id}/downlink/udp Send data using IoT SIM via UDP #
POST /sims/{sim_id}/enable_termination Enables termination of the SIM #
GET /sims/{sim_id}/events/sessions Retrieves session event history (session history) #
GET /sims/{sim_id}/packet_capture_sessions Lists packet capture sessions associated with the SIM #
POST /sims/{sim_id}/packet_capture_sessions Creates a packet capture session associated with the SIM #
DELETE /sims/{sim_id}/packet_capture_sessions/{session_id} Deletes a packet capture session associated with the SIM #
GET /sims/{sim_id}/packet_capture_sessions/{session_id} Gets a packet capture session associated with the SIM #
POST /sims/{sim_id}/packet_capture_sessions/{session_id}/stop Stops a packet capture session associated with the SIM #
POST /sims/{sim_id}/profiles/{iccid}/add_subscription Adds a new secondary subscription to an IoT SIM #
POST /sims/{sim_id}/profiles/{iccid}/subscribers/{imsi}/cancel_download Cancel the OTA to the subscription container for an additional subscription #
POST /sims/{sim_id}/profiles/{iccid}/subscribers/{imsi}/terminate Terminates subscription container #
POST /sims/{sim_id}/register Registers an IoT SIM to an operator #
POST /sims/{sim_id}/report_local_info Gets SIM local information report #
POST /sims/{sim_id}/send_sms Send an SMS to an IoT SIM #
POST /sims/{sim_id}/sessions/arc Creates a Soracom Arc session #
POST /sims/{sim_id}/set_expiry_time Sets expiry time of IoT SIM #
POST /sims/{sim_id}/set_group Adds a SIM to a SIM group #
POST /sims/{sim_id}/set_imei_lock Sets IMEI lock configuration for the SIM #
POST /sims/{sim_id}/set_to_standby Set SIM to standby mode #
GET /sims/{sim_id}/statuses/history List IoT SIM status operation history #
POST /sims/{sim_id}/suspend Suspend SIM #
PUT /sims/{sim_id}/tags Bulk Add or Update tags for an IoT SIM #
DELETE /sims/{sim_id}/tags/{tag_name} Deletes a tag from the specified SIM #
POST /sims/{sim_id}/terminate Terminate an IoT SIM #
GET /sims/{sim_id}/testing/usage Get usage of IoT SIM in testing status #
POST /sims/{sim_id}/unset_expiry_time Deletes expiry time of the SIM #
POST /sims/{sim_id}/unset_group Removes a SIM from a SIM group #
POST /sims/{sim_id}/unset_imei_lock Unsets IMEI lock of SIM #
POST /sims/{sim_id}/update_speed_class Updates the IoT SIM speed class #

Documentation

📖
Documentation
https://developers.soracom.io/en/docs/air/
📖
Documentation
https://users.soracom.io/ja-jp/tools/api/reference/#/Sim

Specifications

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-schema/soracom-sim-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/json-structure/soracom-sim-structure.json

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/examples/soracom-sim-list-example.json
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/apis.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-audit-sim-session-events-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-collect-sim-harvest-data-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-create-traffic-event-handler-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-deactivate-sim-with-guard-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-export-monthly-billing-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-provision-group-and-attach-sim-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-register-and-activate-sim-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-register-and-verify-coupon-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-register-device-to-group-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-register-subscriber-to-group-workflow.yml
🔗
Arazzo
https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/arazzo/soracom-send-sms-to-active-sim-workflow.yml

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-sim-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-sim-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Soracom API v1
  title: Soracom Sim 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 (117 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/soracom/refs/heads/main/openapi/soracom-sim-api-openapi.yml