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

Manage Soracom Lagoon (managed Grafana) subscription, plan tier, organization, dashboards, users, licenses, and data sources.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include IoT, Lagoon, Dashboards, and Visualization. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 12 operations across 10 paths, and defines 11 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 10 paths 11 schemas 1 DELETE3 GET3 POST5 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 Lagoon 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 10 paths, the API surfaces 12 operations — 1 DELETE, 3 GET, 3 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Lagoon 12

[Soracom Lagoon](/en/docs/lagoon-v3/) User and plan management

GET
/lagoon/image/link
Get a custom icon image link of Soracom Lagoon Console
getImageLink → 200400
GET
/lagoon/license_packs
Get the status of active Soracom Lagoon license packs
listLagoonLicensePackStatus → 200400
PUT
/lagoon/license_packs
Update the quantities for license packs of Soracom Lagoon
updateLagoonLicensePack body → 204400404
PUT
/lagoon/plan
Update the plan of Soracom Lagoon
updateLagoonPlan body → 204400404
POST
/lagoon/register
Register (activate) Soracom Lagoon
registerLagoon body → 201400
POST
/lagoon/terminate
Terminate (deactivate) Soracom Lagoon
terminateLagoon → 204400404
GET
/lagoon/users
List Soracom Lagoon users that belong to operator
listLagoonUsers → 200400
POST
/lagoon/users
Create a Soracom Lagoon user
createLagoonUser body → 201400
DELETE
/lagoon/users/{lagoon_user_id}
Delete a Soracom Lagoon user
deleteLagoonUser 1 param → 204400
PUT
/lagoon/users/{lagoon_user_id}/email
Update email address of a Soracom Lagoon user
updateLagoonUserEmail 1 param body → 200400
PUT
/lagoon/users/{lagoon_user_id}/password
Update password of a Soracom Lagoon user
updateLagoonUserPassword 1 param body → 200400
PUT
/lagoon/users/{lagoon_user_id}/permission
Update permission of a Soracom Lagoon user
updateLagoonUserPermission 1 param body → 200400

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are LagoonUser (5 properties), LagoonUserCreationRequest (3 properties), LagoonRegistrationRequest (2 properties), LagoonUserPasswordUpdatingRequest (2 properties). Each schema is shown below with its type and property counts.

LagoonUserCreationRequest
object
3 properties
LagoonUserPermissionUpdatingRequest
object
1 property
LagoonUserCreationResponse
object
1 property
LagoonUser
object
5 properties
LagoonUserPasswordUpdatingRequest
object
2 properties
LagoonLicensePacksUpdatingRequest
object
1 property
LagoonRegistrationResponse
object
1 property
LagoonPlanChangingRequest
object
1 property
LagoonRegistrationRequest
object
2 properties
LagoonUserEmailUpdatingRequest
object
1 property
LagoonLicensePackStatusResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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