STstarlink
Data Pools

Query data pool usage with service line and monthly breakdowns.

Changed on

Required permission: Service plan, View.<br/>Use this endpoint to track:

  • Current pool capacity and usage
  • Per-service-line usage breakdown
  • Historical usage by month
get/public/v2/data-pools/usage

Request

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

Query parameters

dataPoolIdsstring[]

Data pool Ids to filter by. Queries for usage of all data pools on account if omitted

asOfTimestampstring date-time

Optional timestamp for snapshotting data pool usage as of this time. Only includes data blocks that are active at this instant (i.e., StartDate <= asOfTimestamp < EndDate). Defaults to DateTimeOffset.UtcNow to return currently active blocks.

pageinteger

The index of the page, starting at 0.

limitinteger

Amount of data pool usage summaries to retrieve per page. Defaults to 50, can request up to 100.

Response

OK

informationstring[] nullable
isValidboolean

Changes

  • dfd7014cfd6dRevision changes
    • info

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