Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wherobots usage API

The usage API from Wherobots — 5 operation(s) for usage.

Wherobots usage API is one of 34 APIs that Wherobots publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include usage. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://api.cloud.wherobots.com.

5 operations 5 paths 19 schemas 4 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://api.cloud.wherobots.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Wherobots usage API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerToken). An API key is passed in the header as X-API-Key (wherobotsApiKey).

  • wherobotsApiKey — A Wherobots-generated API key

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

usage 5
GET
/usage/workloads/chart
Get workload usage chart data
getWorkloadUsageChart 1 param → 200400401403404409422500
GET
/usage/workloads/info
Get workload usage summary info
getWorkloadUsageInfo 4 params → 200400401403404409422500
GET
/usage/workloads
Get workload usage (deprecated)
getWorkloadUsage 4 params → 200400401403404409422500
GET
/usage/history
Get workload usage history
getWorkloadHistory 3 params → 200400401403404409422500
POST
/usage/costs
Get workload cost breakdown
getWorkloadCosts body → 200400401403404409422500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are WorkloadHistoryItem (21 properties), WorkloadCostAvailable (9 properties), ErrorInfo (7 properties), UsageKey (4 properties). Each schema is shown below with its type and property counts.

ErrorInfo
object
7 properties 4 required
WorkloadType
string
WorkloadCostsOutput
object
Batch response envelope. Contract (enforced by the service that constructs this, not by the schema): costs.keys() == set(input.kubeappids). Every requested id…
1 property
AppStatus
string
WorkloadCostStatus
string
Lifecycle status of a materialized workload cost record. LIVE - Workload is still running; cost may continue to accumulate. Refreshed from the upstream billing…
UsageKey
object
4 properties 4 required
AppType
string
TimerangeOption
string
ErrorBody
object
2 properties 2 required
RunStatus
string
GetKubeAppCostsInput
object
1 property 1 required
UsageSlice
object
2 properties 2 required
WorkloadCostUnavailableReason
string
Why a workload cost could not be returned. NOTFOUND - The kubeappid is not known to the billing system, or the caller is not authorized to see it. Indistinguis…
ChartSlice
object
3 properties 3 required
WorkloadCostAvailable
object
A workload cost we were able to resolve.
9 properties 7 required
WorkloadHistoryItem
object
Unified workload history item representing either a KubeApp or a Union workflow execution.
21 properties 5 required
WorkloadStatus
string
ErrorClass
string
WorkloadCostUnavailable
object
A workload cost we could not resolve, with a structured reason.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wherobots-usage-api-openapi.yml Raw ↑

Other APIs Wherobots publishes across the network.

Wherobots apikey API
Wherobots audit-log API
Wherobots catalogs API
Wherobots cloud-connections API
Wherobots coupon API
Wherobots environment-override--preset API
Wherobots environment-preset API
Wherobots files API
Wherobots Flags API
Wherobots foreign-catalog API
Wherobots Health API
Wherobots Is Super User API