Starlink ETL service API docs

🔐 Authentication

Get Access Token

URL: https://api.starlink.com/auth/connect/token
Method: POST
Description: Obtain an access token to authenticate further API requests.
Headers:
- Content-Type: application/x-www-form-urlencoded
Body Parameters:
- grant_type, client_id, client_secret, etc. (based on OAuth2 spec)

📘 Account APIs

1. Get Accounts

URL: https://web-api.starlink.com/enterprise/v1/accounts
Method: GET
Description: Retrieves a list of Starlink enterprise accounts.

✅ Sample Response:

CODE

{
  "content": {
    "totalCount": 2,
    "pageIndex": 0,
    "limit": 50,
    "isLastPage": true,
    "results": [
      {
        "accountNumber": "***************",
        "regionCode": "GB",
        "accountName": "**********",
        "defaultRouterConfigId": null,
        "defaultRouterTlsDomain": null
      }
    ]
  },
  "errors": [],
  "warnings": [],
  "information": [],
  "isValid": true
}

2. Get Account Address

URL: https://web-api.starlink.com/enterprise/v1/account/{accountNumber}/addresses
Method: GET
Description: Fetches physical addresses associated with an account.

✅ Sample Response:

CODE

{
  "content": {
    "totalCount": 268,
    "results": [
      {
        "addressReferenceId": "****************",
        "addressLines": ["Harfrey's Road"],
        "locality": "Gr*****",
        "administrativeArea": "England",
        "postalCode": "NR31 0LS",
        "formattedAddress": "********, UK",
        "latitude": 52.**,
        "longitude": 1.**
      }
    ]
  },
  "isValid": true
}

🛰️ Service Line APIs

3. Get Service Lines

URL: https://web-api.starlink.com/enterprise/v1/account/{accountNumber}/service-lines
Method: GET
Description: Fetches service lines associated with a given account.

✅ Sample Response:

CODE

{
  "content": {
    "results": [
      {
        "serviceLineNumber": "SL-**********",
        "nickname": "MCS Swath 3",
        "productReferenceId": "gb-*******",
        "startDate": "2025-08-25T14:00:58.602334+00:00",
        "active": true
      }
    ]
  },
  "isValid": true
}

4. Get Available Products

URL: https://web-api.starlink.com/enterprise/v1/account/{accountNumber}/service-lines/available-products
Method: GET
Description: Lists available Starlink products for an account.

✅ Sample Response:

CODE

{
  "content": {
    "results": [
      {
        "productReferenceId": "gb-enterprise-**************",
        "name": "Global Priority ************",
        "price": 150,
        "isoCurrencyCode": "USD"
      }
    ]
  },
  "isValid": true
}

📊 Usage & Billing

5. Get Billing & Usage Details

URL: https://web-api.starlink.com/enterprise/v1/accounts/{accountNumber}/billing-cycles/query
Method: POST
Description: Retrieves billing cycles and data usage for the account.

✅ Sample Response (excerpted):

CODE

{
  "content": {
    "results": [
      {
        "accountNumber": "ACC-*******",
        "serviceLineNumber": "SL-*******",
        "billingCycles": [
          {
            "startDate": "2025-08-01T00:00:00+00:00",
            "endDate": "2025-09-01T00:00:00+00:00",
            "dailyDataUsage": [
              {
                "date": "2025-08-10T00:00:00+00:00",
                "priorityGB": 1.13,
                "standardGB": 0,
                "nonBillableGB": 0
              }
            ]
          }
        ]
      }
    ]
  },
  "isValid": true
}

🧑‍💻 User Terminals & Routers

6. Get User Terminals

URL: https://web-api.starlink.com/enterprise/v1/account/{accountNumber}/user-terminals
Method: GET
Description: Returns user terminals (UTs) and their linked routers.

✅ Sample Response:

CODE

{
  "content": {
    "results": [
      {
        "userTerminalId": "01000000-*******",
        "kitSerialNumber": "KIT*******",
        "dishSerialNumber": "HP********",
        "routers": [
          {
            "routerId": "0100000********",
            "directLinkToDish": false
          }
        ]
      }
    ]
  },
  "isValid": true
}

7. Get Router Configurations

URL: https://web-api.starlink.com/enterprise/v1/account/{accountNumber}/routers/configs
Method: GET
Description: Retrieves configuration JSONs for routers under the given account.

✅ Sample Response (excerpted):

CODE

{
  "content": {
    "results": [
      {
        "configId": "DVC_CFG-*******",
        "nickname": "Ray ****",
        "routerConfigJson": "{ \"setupComplete\": true, ... }"
      }
    ]
  },
  "isValid": true
}