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

Starlink User Terminals API

The User Terminals API from Starlink — 6 operation(s) for user terminals.

Starlink User Terminals API is one of 16 APIs that Starlink publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Terminals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 7 operations across 6 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2.

Requests are made against a single base URL, /api.

7 operations 6 paths 12 schemas 1 DELETE2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2
Base URL
https://starlink.com/api/public/v2
Resource Areas
1

Paths & Operations 7

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

User Terminals 7
GET
/public/v2/user-terminals
Get all user terminals
5 params → 400401403200422
POST
/public/v2/user-terminals
Add user terminal to account
body → 400401403200422
DELETE
/public/v2/user-terminals/{deviceId}
Remove user terminal from account
1 param → 400401403200422
POST
/public/v2/user-terminals/{deviceId}/reboot
Reboot user terminal
1 param → 400401403200422
PUT
/public/v2/user-terminals/configs/assign
User terminal config assignment
body → 400401403200422
GET
/public/v2/user-terminals/l2vpn
Get L2VPN circuits available for this account
→ 401403200422
PUT
/public/v2/user-terminals/{deviceId}/l2vpn
Set L2VPN VLANs for user terminal
1 param body → 400401403200422

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are UserTerminalResponseV2 (7 properties), RouterResponseV2 (6 properties), L2VpnCircuitResponseListServiceResponse (5 properties), L2VpnCircuitDefinition (5 properties). Each schema is shown below with its type and property counts.

UserTerminalResponseV2
object
7 properties
ServiceResponse
object
4 properties
L2VpnSetCircuitRequest
object
5 properties 2 required
DeviceIdRequest
object
1 property 1 required
L2VpnCircuitResponse
object
3 properties
L2VpnCircuitDefinition
object
5 properties
ValidationResult
object
2 properties
AssignUserTerminalsConfigRequest
object
2 properties 1 required
L2VpnCircuitResponseListServiceResponse
object
5 properties
UserTerminalResponseV2Paginated
object
5 properties
UserTerminalResponseV2PaginatedServiceResponse
object
5 properties
RouterResponseV2
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

starlink-user-terminals-api-openapi.yml Raw ↑

Other APIs Starlink publishes across the network.

Starlink Telemetry Stream API
Starlink Local Device API
Starlink Router Local HTTPS API
Starlink Space Traffic Coordination API
Starlink Account API
Starlink Addresses API
Starlink Billing API
Starlink Contacts API
Starlink Data Pools API
Starlink Flights API
Starlink Managed Accounts API
Starlink Managed API
Where this information came from

This is an independent, third-party profile of Starlink User Terminals 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.