How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
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.

Documentation Provider Profile APIs.io OpenAPI GitHub

Soracom SIM Management API is one of 45 APIs that Soracom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include IoT, Cellular, SIM, and Subscriber. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 2 JSON Schemas.

This API exposes 45 operations across 40 paths, and defines 63 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.

45 operations 40 paths 63 schemas 3 DELETE8 GET32 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20250903-043502
Base URL
https://api.soracom.io/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Soracom SIM Management 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 40 paths, the API surfaces 45 operations — 3 DELETE, 8 GET, 32 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Sim 45

[Soracom Air for Cellular](/en/docs/air/) SIM information, operations, and cancellation (New API equivalent to Subscriber but supports subscription containers)

GET
/sims
List SIMs
listSims 2 params → 200404
POST
/sims
Creates a new virtual SIM/Subscriber
createSim body → 201
GET
/sims/{sim_id}
Gets information about the IoT SIM
getSim 1 param → 200404
POST
/sims/{sim_id}/activate
Activate SIM
activateSim 1 param → 200404
DELETE
/sims/{sim_id}/credentials/arcdeprecated
(DEPRECATED) Removes the credentials for Arc from a SIM
removeArcSimCredentials 1 param → 204
POST
/sims/{sim_id}/credentials/arcdeprecated
(DEPRECATED) Attaches the credentials for Arc to a SIM
attachArcSimCredentials 1 param body → 200
PUT
/sims/{sim_id}/credentials/arc
Renew the credentials for Arc to a SIM
renewArcSimCredentials 1 param body → 200
GET
/sims/{sim_id}/data
Get data sent from a SIM to Harvest Data.
getDataFromSim 6 params → 200
POST
/sims/{sim_id}/deactivate
Deactivate SIM
deactivateSim 1 param → 200404
POST
/sims/{sim_id}/delete_session
Delete and reconnect the Session
deleteSimSession 1 param → 200404
POST
/sims/{sim_id}/disable_termination
Disables termination of the SIM
disableSimTermination 1 param → 200404
POST
/sims/{sim_id}/downlink/http
Send an HTTP request to a device using an IoT SIM
sendDownlinkHttp 1 param body → 200404422
POST
/sims/{sim_id}/downlink/ping
Sends ping requests to a SIM.
sendDownlinkPing 1 param body → 200
POST
/sims/{sim_id}/downlink/rtsp
Send a command to a RTSP stream to a device using an IoT SIM
sendDownlinkRtsp 1 param body → 200400403404422
POST
/sims/{sim_id}/downlink/ssh
Connect to a device using an IoT SIM via SSH and execute a specified command
sendDownlinkSsh 1 param body → 200422
POST
/sims/{sim_id}/downlink/tcp
Connect to a device using an IoT SIM via TCP and send/receive data
sendDownlinkTcp 1 param body → 200400403404422
POST
/sims/{sim_id}/downlink/udp
Send data using IoT SIM via UDP
sendDownlinkUdp 1 param body → 204400403404
POST
/sims/{sim_id}/enable_termination
Enables termination of the SIM.
enableSimTermination 1 param → 200404
GET
/sims/{sim_id}/events/sessions
Retrieves session event history (session history)
listSimSessionEvents 5 params → 200
GET
/sims/{sim_id}/packet_capture_sessions
Lists packet capture sessions associated with the SIM
listSimPacketCaptureSessions 3 params → 200404
POST
/sims/{sim_id}/packet_capture_sessions
Creates a packet capture session associated with the SIM
createSimPacketCaptureSession 1 param body → 200400404
DELETE
/sims/{sim_id}/packet_capture_sessions/{session_id}
Deletes a packet capture session associated with the SIM
deleteSimPacketCaptureSession 2 params → 200400404
GET
/sims/{sim_id}/packet_capture_sessions/{session_id}
Gets a packet capture session associated with the SIM
getSimPacketCaptureSession 2 params → 200404
POST
/sims/{sim_id}/packet_capture_sessions/{session_id}/stop
Stops a packet capture session associated with the SIM
stopSimPacketCaptureSession 2 params → 200400404500
POST
/sims/{sim_id}/profiles/{iccid}/add_subscription
Adds a new secondary subscription to an IoT SIM
addSubscription 2 params body → 200400404
POST
/sims/{sim_id}/profiles/{iccid}/subscribers/{imsi}/cancel_download
Cancel the OTA to the subscription container for an additional subscription
cancelSubscriptionContainerDownload 3 params → 200404
POST
/sims/{sim_id}/profiles/{iccid}/subscribers/{imsi}/terminate
Terminates subscription container
terminateSubscriptionContainer 3 params → 204
POST
/sims/{sim_id}/register
Registers an IoT SIM to an operator
registerSim 1 param body → 201
POST
/sims/{sim_id}/report_local_info
Gets SIM local information report
reportSimLocalInfo 1 param → 202400404
POST
/sims/{sim_id}/send_sms
Send an SMS to an IoT SIM
sendSmsToSim 1 param body → 202400404
POST
/sims/{sim_id}/sessions/arc
Creates a Soracom Arc session
createArcSession 1 param body → 200400
POST
/sims/{sim_id}/set_expiry_time
Sets expiry time of IoT SIM
setSimExpiryTime 1 param body → 200404
POST
/sims/{sim_id}/set_group
Adds a SIM to a SIM group
setSimGroup 1 param body → 200404
POST
/sims/{sim_id}/set_imei_lock
Sets IMEI lock configuration for the SIM
setSimImeiLock 1 param body → 200400404
POST
/sims/{sim_id}/set_to_standby
Set SIM to standby mode.
setSimToStandby 1 param → 200400404
GET
/sims/{sim_id}/statuses/history
List IoT SIM status operation history
listSimStatusHistory 6 params → 200400404
POST
/sims/{sim_id}/suspend
Suspend SIM
suspendSim 1 param → 200404
PUT
/sims/{sim_id}/tags
Bulk Add or Update tags for an IoT SIM
putSimTags 1 param body → 200404
DELETE
/sims/{sim_id}/tags/{tag_name}
Deletes a tag from the specified SIM
deleteSimTag 2 params → 204404
POST
/sims/{sim_id}/terminate
Terminate an IoT SIM
terminateSim 1 param → 200404
GET
/sims/{sim_id}/testing/usage
Get usage of IoT SIM in testing status
getTestingUsage 1 param → 200404
POST
/sims/{sim_id}/unset_expiry_time
Deletes expiry time of the SIM
unsetSimExpiryTime 1 param → 204404
POST
/sims/{sim_id}/unset_group
Removes a SIM from a SIM group
unsetSimGroup 1 param → 200404
POST
/sims/{sim_id}/unset_imei_lock
Unsets IMEI lock of SIM
unsetSimImeiLock 1 param → 200404
POST
/sims/{sim_id}/update_speed_class
Updates the IoT SIM speed class
updateSimSpeedClass 1 param body → 200400404

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are Subscriber (33 properties), Sim (28 properties), SessionEvent (17 properties), SessionStatus (14 properties). Each schema is shown below with its type and property counts.

PacketCaptureSession
object
9 properties
TagUpdateRequest
object
2 properties 2 required
Placement
object
2 properties
SubscriptionContainer
object
3 properties
ArcSessionStatus
object
10 properties
CreateSimRequest
object
2 properties 2 required
SimDownlinkTcpConnectionWaitForPatternOptions
object
Establishes a TCP connection with the device and sends the specified data, then waits for data reception from the device. Then, returns the data received until…
3 properties 1 required
SubscriptionContainerStatus
object
2 properties
SimDownlinkRtspRequest
object
5 properties 1 required
SimDownlinkUdpRequest
object
3 properties 2 required
TagSet
object
An object which always contains at least one property "name" with a string value. If you give a subscriber/SIM a name, the name will be returned as the value o…
SetGroupRequest
object
1 property
SimDownlinkTcpConnectionWaitAllOptions
object
Establishes a TCP connection with the device and sends the specified data, then waits for data reception from the device. Then, returns the data received durin…
1 property
SimDownlinkTcpConnectionIdleTimeoutOptions
object
Establishes a TCP connection with the device and sends the specified data, then waits for data reception from the device. After data reception begins, if no da…
2 properties 1 required
SessionStatus
object
Information about the current session.
14 properties
ArcCredentialRenewRequest
object
1 property
PacketCaptureSessionRequest
object
2 properties 1 required
SimDownlinkRtspAuthenticationBasic
object
Configuration for RTSP connection with basic authentication using username and password.
4 properties 2 required
ImeiLock
object
IMEI lock configuration.
1 property
SimStatusHistoryResponse
object
10 properties
SimDownlinkTcpConnectionFireAndForgetOptions
object
Establishes a TCP connection with the device and attempts to send specified data, then returns the API response. - Does not wait for data reception from the de…
1 property
Map
object
LocationRegistrationStatusForNetwork
object
2 properties
SimProfile
object
6 properties
SetImeiLockRequest
object
1 property
TestingUsage
object
4 properties 2 required
DownlinkPingRequest
object
2 properties
RegisterSimRequest
object
3 properties 1 required
SimDownlinkRtspSnapshotImageResponse
string
Response containing the snapshot image taken from the RTSP stream when the command is snapshot. The image is Base64-encoded.
SimDownlinkRtspAuthenticationNone
object
Configuration for RTSP connection with no authentication
1 property 1 required
ArcCredentialAttachRequest
object
1 property
SimDownlinkRtspCommandSnapshotHarvestFilesDestinationOptions
object
1 property 1 required
DownlinkPingResponse
object
3 properties
UpdateSpeedClassRequest
object
1 property 1 required
DataEntry
object
6 properties
SimDownlinkRtspCommandSnapshotOptions
object
1 property
PreviousSessionStatus
object
Information about the previous session.
12 properties
Capabilities
object
2 properties
ArcSessionCreateResponse
object
5 properties
ArcCredentialAttachResponse
object
2 properties
SimDownlinkHttpRequest
object
8 properties
Sim
object
28 properties
LocationRegistrationStatus
object
3 properties
ExpiryTime
object
2 properties 1 required
SimDownlinkTcpResponse
object
Response for the TCP connection
2 properties 1 required
SimDownlinkSshNoAuthentication
object
Configuration for SSH connection with no authentication ("type": "none").
1 property
SimDownlinkBinaryEncoding
string
Encoding format for binary data. "string" is treated as a UTF-8 string. "base64" is Base64 encoding, and "hex" is hexadecimal encoding. Case insensitive for he…
SimplifiedSubscriber
object
6 properties
Subscriber
object
33 properties
SmsForwardingRequest
object
2 properties
SimDownlinkSshPasswordAuthentication
object
Configuration for SSH connection using password authentication ("type": "password"). Specify either password or passwordCredentialsId.
3 properties
SimDownlinkTcpRequest
object
5 properties 2 required
Cell
object
Information about the base station to which the IoT SIM is connected. It will not be output for virtual SIM/subscribers.
9 properties
SessionEvent
object
17 properties
SimDownlinkSshRequest
object
4 properties 3 required
SmsForwardingReport
object
1 property
SimDownlinkHttpResponse
object
4 properties 1 required
SimDownlinkTcpConnectionWaitFirstOptions
object
Establishes a TCP connection with the device and sends the specified data. Then, as soon as the first data from the device is received, the TCP connection is t…
1 property
SimDownlinkSshResponse
object
5 properties 1 required
ArcCredentialRenewResponse
object
2 properties
APICallErrorMessage
object
2 properties 2 required
SimDownlinkRtspCommandSnapshot
string
Request to take a snapshot of the RTSP stream.
SimDownlinkSshPublicKeyAuthentication
object
Configuration for SSH connection using public key authentication ("type": "publickey").
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-sim-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom Group Configuration API
AE Profile APIs.io
Soracom Billing API
AE Profile APIs.io
Soracom Stats and Diagnostics API
AE Profile APIs.io
Soracom Auth and Access Management API
AE Profile APIs.io
Soracom Lagoon API
AE Profile APIs.io
Soracom Cloud Camera Services API
AE Profile APIs.io
Soracom Batch API
AE Profile APIs.io
Soracom Analysis API
AE Profile APIs.io
Soracom API Sandbox: Coupon API
AE Profile APIs.io
Soracom API Sandbox: Operator API
AE Profile APIs.io
Soracom API Sandbox: Order API
AE Profile APIs.io
Soracom API Sandbox: Stats API
AE Profile APIs.io
#IoT#Cellular#SIM#Subscriber
← Back to S APIs
API Details
ID
soracom:soracom-sim-api
Base URL
https://api.soracom.io/v1
Docs
https://users.soracom.io/ja-jp/tools/api/reference/#/Sim
Provider
Soracom
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=soracom-sim-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/soracom-sim-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Soracom SIM Management 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.