Akter

Usage

What an organization used and spent, in the units it pays for (ADR 0020): commands, storage, snapshots, computer vCPU and memory time, exec calls and egress.

Get⁠

GEThttps://api.akter.dev/v1/organizations/{organization}/usage
usage.getBearer token

Read a month's usage and spend per meter, for the organization, one app or one API key. Usage reaches it within about two minutes.

Path parameters

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

Query parameters

  • appstring

    Only this app's usage.

  • keystring

    Only the usage this API key started.

  • periodstring

    The month to read. Defaults to this month.

Response 200Usage

  • apiKeystring

    An opaque id that starts with key_.

  • appstring

    An app's name, unique within its organization. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • capUsdnumberrequired

    The organization's spend cap for the month, or the key's when key was asked.

  • metersMeterUsage[]required
  • meters[].meter"commands" | "queries" | "storage" | "snapshots" | "computerVcpu" | "computerMemory" | "execCalls" | "egress" | "planMinimum"required
  • meters[].quantitynumberrequired

    How much was used, in unit.

  • meters[].spentUsdnumberrequired

    US dollars.

  • meters[].unitstringrequired

    The unit prices are quoted in: million commands, million queries, GiB-month, vCPU-hour, GiB-hour, thousand calls, GB or USD.

  • periodstringrequired

    A calendar month in UTC, YYYY-MM. Usage, caps and invoices are counted per month.

  • spentUsdnumberrequired

    US dollars.

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Forecast⁠

GEThttps://api.akter.dev/v1/organizations/{organization}/usage/forecast
usage.forecastBearer token

Project this month's spend to the month's end at its average rate so far.

Path parameters

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

Response 200UsageForecast

  • capUsdnumberrequired

    US dollars.

  • periodstringrequired

    A calendar month in UTC, YYYY-MM. Usage, caps and invoices are counted per month.

  • projectedUsdnumberrequired

    This month's spend so far carried to the month's end at its average rate.

  • spentUsdnumberrequired

    US dollars.

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError