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 Device API

[Soracom Inventory devices](/en/docs/inventory/)

Documentation Provider Profile APIs.io OpenAPI GitHub

Soracom Device 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 Device. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 4 JSON Schemas.

This API exposes 17 operations across 14 paths, and defines 6 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.

17 operations 14 paths 6 schemas 2 DELETE5 GET8 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 Device 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 17

Across 14 paths, the API surfaces 17 operations — 2 DELETE, 5 GET, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Device 17

[Soracom Inventory devices](/en/docs/inventory/)

GET
/devices
Returns a list of Devices
listDevices 5 params → 200
POST
/devices
Creates a new Device
createDevice body → 201
DELETE
/devices/{device_id}
Delete Device
deleteDevice 1 param → 204404
GET
/devices/{device_id}
Returns a Device identified by device ID
getDevice 2 params → 200404
GET
/devices/{device_id}/{object}/{instance}
Get resources under an object instance of a device
readDeviceResources 4 params → 200400404
GET
/devices/{device_id}/{object}/{instance}/{resource}
Get the specified resource of a device
readDeviceResource 5 params → 200400404
PUT
/devices/{device_id}/{object}/{instance}/{resource}
Write value to a resource of a device
writeDeviceResource 4 params body → 202400404500
POST
/devices/{device_id}/{object}/{instance}/{resource}/execute
Executes a resource of a device
executeDeviceResource 4 params body → 202400404
POST
/devices/{device_id}/{object}/{instance}/{resource}/observe
Triggers observation of the specified resource of a device
observeDeviceResource 5 params → 202400404
POST
/devices/{device_id}/{object}/{instance}/{resource}/unobserve
Stops observation of a resource of a device
unobserveDeviceResource 4 params → 204404
POST
/devices/{device_id}/{object}/{instance}/observe
Triggers observation of resources under an object instance of a device
observeDeviceResources 4 params → 202400404
POST
/devices/{device_id}/{object}/{instance}/unobserve
Stops observation of resources under an object instance of a device
unobserveDeviceResources 3 params → 204404
GET
/devices/{device_id}/data
Retrieves data sent from an Inventory device to Harvest Data
getDataFromDevice 6 params → 200
POST
/devices/{device_id}/set_group
Adds an Inventory device to an Inventory group
setDeviceGroup 1 param body → 200404
PUT
/devices/{device_id}/tags
Updates device tags
putDeviceTags 1 param body → 200404
DELETE
/devices/{device_id}/tags/{tag_name}
Delete device tag
deleteDeviceTag 2 params → 204404
POST
/devices/{device_id}/unset_group
Removes an Inventory device from an Inventory group
unsetDeviceGroup 1 param → 200404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Device (16 properties), ResourceInstance (12 properties), DataEntry (6 properties), ObjectInstance (3 properties). Each schema is shown below with its type and property counts.

ObjectInstance
object
3 properties
TagUpdateRequest
object
2 properties 2 required
DataEntry
object
6 properties
SetGroupRequest
object
1 property
ResourceInstance
object
12 properties
Device
object
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-device-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom SIM Management API
AE Profile APIs.io
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
#Device
← Back to S APIs
API Details
ID
soracom:soracom-device-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-device-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/soracom-device-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 Device 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.