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 Group Configuration API

Manage Soracom groups and per-service configuration. Groups bind SIMs and devices to namespaced configuration for SoracomAir, SoracomBeam, SoracomFunnel, SoracomFunk, SoracomHarvest, SoracomJunction, SoracomOrbit, and metadata services.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 1 JSON Schema definition.

Tagged areas include IoT, Group, and Configuration. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and 1 JSON Schema.

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

10 operations 7 paths 17 schemas 4 DELETE3 GET1 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 Group Configuration 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 10

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

Group 10

[Group configuration](/en/docs/group-configuration/)

GET
/groups
List Groups.
listGroups 5 params → 200
POST
/groups
Create Group
createGroup body → 201
DELETE
/groups/{group_id}
Delete Group
deleteGroup 1 param → 204404
GET
/groups/{group_id}
Get Group
getGroup 1 param → 200404
DELETE
/groups/{group_id}/configuration/{namespace}
Delete Group Configuration Namespace
deleteConfigurationNamespace 2 params → 204400404
PUT
/groups/{group_id}/configuration/{namespace}
Update group configuration
putConfigurationParameters 2 params body → 200404
DELETE
/groups/{group_id}/configuration/{namespace}/{name}
Delete Group Configuration Parameters
deleteConfigurationParameter 3 params → 204404
GET
/groups/{group_id}/subscribers
List Subscribers in a group
listSubscribersInGroup 3 params → 200404
PUT
/groups/{group_id}/tags
Update Group Tags
putGroupTags 1 param body → 200404
DELETE
/groups/{group_id}/tags/{tag_name}
Delete Group Tag
deleteGroupTag 2 params → 204404

Schemas 17

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

TagUpdateRequest
object
2 properties 2 required
Placement
object
2 properties
Group
object
6 properties
ImeiLock
object
IMEI lock configuration.
1 property
ArcSessionStatus
object
10 properties
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
Capabilities
object
2 properties
PreviousSessionStatus
object
Information about the previous session.
12 properties
GroupConfigurationUpdateRequest
object
2 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…
Sim
object
28 properties
Map
object
CreateGroupRequest
object
2 properties
GroupConfiguration
object
SimProfile
object
6 properties
SessionStatus
object
Information about the current session.
14 properties
SimplifiedSubscriber
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

soracom-group-api-openapi.yml Raw ↑

Other APIs Soracom publishes across the network.

Soracom SIM Management 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#Group#Configuration
← Back to S APIs
API Details
ID
soracom:soracom-group-api
Base URL
https://api.soracom.io/v1
Docs
https://users.soracom.io/ja-jp/tools/api/reference/#/Group
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-group-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/soracom-group-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 Group Configuration 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.