View Usage

Returns the usage of the account.

get/usage

Request

  • Base URL
    https://app.bitlaunch.io/api
  • URL
    https://app.bitlaunch.io/api/usage
  • Auth
    API key in header Authorization

Query parameters

periodstring required

Filter for the search, format "YYYY-MM" or use "latest"

Response

200

backupUsageunknown
totalUsdinteger
prevMonthstring
thisMonthstring
nextMonthstring

Example response

{
  "serverUsage": [
    {
      "description": "bitlaunch-ubuntu-lon1-nibble-1024",
      "start": "2020-10-12T13:00:00Z",
      "end": "2020-10-12T18:00:00Z",
      "cost": 135,
      "hours": 5,
      "type": "server"
    }
  ],
  "bandwidthUsage": [
    {
      "description": "bitlaunch-ubuntu-lon1-nibble-1024",
      "start": "2020-10-12T13:00:00Z",
      "end": "2020-10-12T18:00:00Z",
      "type": "bandwidth"
    }
  ],
  "protectionUsage": [
    {
      "description": "bitlaunch-ubuntu-lon1-nibble-1024",
      "start": "2020-10-12T16:00:00Z",
      "end": "2020-10-12T18:00:00Z",
      "cost": 60,
      "hours": 2,
      "type": "protection"
    }
  ],
  "totalUsd": 195,
  "prevMonth": "2020-09",
  "thisMonth": "2020-10"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.