API

One REST surface for the whole network

The SIMSY API is a single, fully-OpenAPI-documented REST surface. Same auth, same base URL, same versioning across every part of the network — SIMs, routing, policies, VSlices, events, diagnostics.

Interactive API docs OpenAPI 3.0.1 spec (JSON)

Base URL

https://api.s-imsy.com

Auth

Bearer <JWT>

Generate API tokens in the SIMSY portal

Spec

OpenAPI 3.0.1

148 endpoints across the surface

First call

Verify a token, list your endpoints

Generate an API token in the SIMSY portal. Every call uses the same Bearer header. The interactive docs let you try every endpoint in the browser.

terminal — verify the token
$ export SIMSY_TOKEN="eyJhbGciOiJI..."

$ curl https://api.s-imsy.com/api/v1/apitokens/verify \
  -H "Authorization: Bearer $SIMSY_TOKEN"

terminal — list endpoints (SIMs)
$ curl https://api.s-imsy.com/api/v1/endpoints \
  -H "Authorization: Bearer $SIMSY_TOKEN"

# Returns endpoint objects with iccid, imsi, msisdn,
# name, reference, vSliceMoniker, routingPolicyName,
# latestCountryName, ipAddress, and more.

Resource groups

What's in the API

The full reference lives in the interactive docs. The groups below give you a feel for the surface area.

Endpoints

/api/v1/endpoints

SIMs and the devices behind them. List, activate, suspend, resume, terminate. Read status, IP addresses, location, access technology, key-values, IMEI lock, metrics. Send SMS. Subscribe to per-endpoint events.

Endpoint Groups

/api/v1/endpointgroups

Logical groupings of endpoints with shared subnet, APN, routing policy, steering profile, session policies, and VSlice membership. The unit you typically manage at scale.

VSlices

/api/v1/vslices

Virtual slices of the network. Configure IP allocation, DNS mode, subnets, regional gateway, and routing policy. Endpoints sharing a VSlice can be put in the same private subnet — this is the building block for Cellular Private LAN.

Routing Policies & Targets

/api/v1/routingpolicies

Where traffic goes. Define routing targets (gateways, customer endpoints) and policies that bind endpoints, endpoint groups, or VSlices to those targets.

Operator & Regional Policies

/api/v1/operatorpolicies

Steer endpoints to specific mobile operators or regional gateways. Control RAT (radio access tech) preference and operator priority lists.

Edge Services

/api/v1/edgeservices

Configure services that run at the SIMSY network edge — things you used to need a CPE rack for.

Events & Event Handlers

/api/v1/events

Read events on the account or a specific endpoint. Wire up event handlers, event maps, event endpoints, and subscriptions to push events to your services.

Trace Sessions & Packet Traces

/api/v1/tracesessions

On-demand network diagnostics. Open a trace session for an endpoint, capture signalling traces, download PCAPs.

Metrics & Account

/api/v1/metrics/datatransfer

Data transfer metrics across the fleet or per endpoint. Customer account state, transactions, tariffs, users, invites, audit activity, credentials.

Authentication

Bearer tokens, scoped per account

All requests authenticate with a JWT in the standard Authorization: Bearer <token> header. Tokens are generated in the SIMSY portal under API Tokens, and can be listed, verified, or revoked through the API itself at /api/v1/apitokens.

Tokens are scoped to your customer account and the user that issued them, with authorisations enforced at /api/v1/authorizations. Treat them like any other secret — rotate periodically, store in a secret manager, never commit to source.

A note on terminology

Why we call them “endpoints” not “devices”

SIMSY operates a mobile core network. From the network's perspective the thing on the other end of a SIM session is an endpoint — identified by ICCID, IMSI, MSISDN, or your own reference. A single endpoint can sit on different hardware over its lifetime (the SIM moves between devices). The API consistently uses the term endpoint, and so do these docs.

Ready to make the first call?

Get a developer SIM and a SIMSY portal account, generate an API token, and you can hit every endpoint on the interactive docs in under five minutes.

Request a developer account Open the API explorer