STstarlink
Data Pools

Get all multi-service line enabled data pools.

Changed on

Required permission: Service plan, View.<br/>Use this endpoint to see all data pools on your account, including:

  • Pool capacity and configuration
  • Recurring data block settings
  • Automatic top-up status
get/public/v2/data-pools

Request

  • Base URL
    https://starlink.com/api
  • URL
    https://starlink.com/api/public/v2/data-pools
  • Auth
    HTTP bearer

Query parameters

productReferenceIdstring

Filter by Product ID of the pool

dataPoolIdsstring[]

Data pool IDs to filter by. Queries for all data pools on account if omitted

pageinteger

The index of the page, starting at 0. Page size is 100

Response

OK

informationstring[] nullable
isValidboolean

Changes

  • dfd7014cfd6dRevision changes
    • info

      added the optional property ///// to the response with the status