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

Soracom SigfoxDevice API

[Soracom Air for Sigfox](/en/docs/air-for-sigfox/) devices

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

This API exposes 12 operations across 11 paths, and defines 7 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.

12 operations 11 paths 7 schemas 1 DELETE3 GET7 POST1 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 SigfoxDevice 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 12

Across 11 paths, the API surfaces 12 operations — 1 DELETE, 3 GET, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

SigfoxDevice 12

[Soracom Air for Sigfox](/en/docs/air-for-sigfox/) devices

GET
/sigfox_devices
List Sigfox devices.
listSigfoxDevices 5 params → 200
GET
/sigfox_devices/{device_id}
Get Sigfox device.
getSigfoxDevice 1 param → 200404
GET
/sigfox_devices/{device_id}/data
Retrieves data sent from a Sigfox device to Harvest Data
getDataFromSigfoxDevice 6 params → 200
POST
/sigfox_devices/{device_id}/data
Send data to a Sigfox device.
sendDataToSigfoxDevice 1 param body → 202404
POST
/sigfox_devices/{device_id}/disable_termination
Disable Termination of Sigfox device.
disableTerminationOnSigfoxDevice 1 param → 200404
POST
/sigfox_devices/{device_id}/enable_termination
Enable Termination of Sigfox device.
enableTerminationOnSigfoxDevice 1 param → 200404
POST
/sigfox_devices/{device_id}/register
Registers a Sigfox device.
registerSigfoxDevice 1 param body → 200400
POST
/sigfox_devices/{device_id}/set_group
Adds a Sigfox device to a Sigfox group
setSigfoxDeviceGroup 1 param body → 200404
PUT
/sigfox_devices/{device_id}/tags
Bulk Insert or Update Sigfox device Tags.
putSigfoxDeviceTags 1 param body → 200404
DELETE
/sigfox_devices/{device_id}/tags/{tag_name}
Delete Sigfox device Tag.
deleteSigfoxDeviceTag 2 params → 204404
POST
/sigfox_devices/{device_id}/terminate
Terminate Sigfox device.
terminateSigfoxDevice 2 params → 200404
POST
/sigfox_devices/{device_id}/unset_group
Removes a Sigfox device from a Sigfox group
unsetSigfoxDeviceGroup 1 param → 200404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are SigfoxDevice (8 properties), DataEntry (6 properties), LastSeen (3 properties), SigfoxRegistrationRequest (2 properties). Each schema is shown below with its type and property counts.

TagUpdateRequest
object
2 properties 2 required
DataEntry
object
6 properties
LastSeen
object
3 properties
SigfoxDevice
object
8 properties
SigfoxRegistrationRequest
object
2 properties
SetGroupRequest
object
1 property
SigfoxData
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-sigfoxdevice-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom SIM Management API
Soracom Group Configuration API
Soracom Billing API
Soracom Stats and Diagnostics API
Soracom Auth and Access Management API
Soracom Lagoon API
Soracom Cloud Camera Services API
Soracom Batch API
Soracom Analysis API
Soracom API Sandbox: Coupon API
Soracom API Sandbox: Operator API
Soracom API Sandbox: Order API
Where this information came from

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