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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Wherobots

Wherobots superuser API

The superuser API from Wherobots — 18 operation(s) for superuser.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 19 operations across 18 paths, and defines 28 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.

19 operations 18 paths 28 schemas 2 DELETE6 GET11 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 superuser 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 19

Across 18 paths, the API surfaces 19 operations — 2 DELETE, 6 GET, 11 POST. Each is listed below with its method, path, parameters, and response codes.

superuser 19
GET
/management/organization/{organization_id}/subscription
Get organization subscription
getOrganizationSubscription 1 param → 200400401403404409422500
POST
/management/organization/{organization_id}/usage/costs
Get organization workload costs
getOrganizationWorkloadCosts 1 param body → 200400401403404409422500
GET
/management/quotas/all
List all organization quotas
listAllQuotas → 200400401403404409422500
GET
/management/organization/{organization_id}/quotas
Get quotas for an organization
getOrganizationQuotas 1 param → 200400401403404409422500
POST
/management/organization/{organization_id}/update-quota
Update a quota for an organization
updateOrganizationQuota 3 params → 200400401403404409422500
POST
/management/organization/{organization_id}/refresh-quotas
Refresh org resource quotas in K8s
refreshOrganizationQuotas 1 param → 200400401403404409422500
POST
/management/organization/{organization_id}/refresh-users
Refresh users in an organization
refreshOrganizationUsers 1 param → 200400401403404409422500
POST
/management/organization/{organization_id}/verify
Verify an organization
verifyOrganization 1 param → 200400401403404409422500
POST
/management/organization/{organization_id}/mark-fraudulent
Mark organization as fraudulent
markOrganizationFraudulent 1 param → 200400401403404409422500
POST
/management/organization/{organization_id}/update-plan
Update organization plan and subscription
updateOrganizationPlan 3 params → 200400401403404409422500
POST
/management/organization/{organization_id}/refresh-catalogs
Refresh catalogs for an organization
refreshOrganizationCatalogs 1 param → 200400401403404409422500
POST
/management/kube_app/{kube_app_id}/destroy
Destroy a workload
destroyWorkload 1 param → 200400401403404409422500
GET
/management/organization/{organization_id}/feature-overrides
Get feature flag overrides for an org
getFeatureOverrides 1 param → 200400401403404409422500
POST
/management/organization/{organization_id}/update-feature-override
Update a feature flag override
updateFeatureOverride 1 param body → 200400401403404409422500
DELETE
/management/organization/{organization_id}
Delete an organization
deleteOrganization 1 param → 200400401403404409422500
POST
/management/async_operation_task
Create an async operation task
createAsyncOperationTask body → 200400401403404409422500
GET
/user-management/{user_id}
Get user by ID
getUserById 1 param → 200400401403404409422500
DELETE
/user-management/{user_id}
Delete a user
deleteUser 1 param → 200400401403404409422500
GET
/user-management/by-email/{email}
Get users by email (partial match)
getUserByEmail 1 param → 200400401403404409422500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are WorkloadCostAvailable (9 properties), SubscriptionInfo (8 properties), HumanPrincipal (8 properties), StripeSubscription (7 properties). Each schema is shown below with its type and property counts.

ErrorInfo
object
7 properties 4 required
QuotaType
string
WherobotsCloudFeature
string
SubscriptionInfo
object
Detailed subscription information including type-specific fields. This model is used across endpoints to return comprehensive subscription data, with optional…
8 properties 5 required
SubscriptionType
string
Subscription type for paid plans (Professional/Enterprise). INTERNALDEVELOPMENT: For internal Wherobots developers, no metering/billing. MANUALCONTRACT: For cu…
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
StripeSubscription
object
7 properties 6 required
HumanPrincipal
object
8 properties 7 required
Plan
string
Body_updateFeatureOverride
object
2 properties 1 required
Policy
object
7 properties 4 required
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…
Provider
string
OperationTaskPayload
object
2 properties 1 required
InternalDevelopmentSubscription
object
5 properties 5 required
AwsMarketplaceSubscription
object
6 properties 6 required
Role-Output
object
6 properties 6 required
ErrorBody
object
2 properties 2 required
FeatureEnabledState
string
GetKubeAppCostsInput
object
1 property 1 required
Effect
string
SubscriptionState
string
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…
WorkloadCostAvailable
object
A workload cost we were able to resolve.
9 properties 7 required
OperationTaskName
string
Enum for all operation task names
ErrorClass
string
OperationTaskParams
object
2 properties
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-superuser-api-openapi.yml Raw ↑

Other APIs Wherobots publishes across the network.

Wherobots apikey API
AE Profile APIs.io
Wherobots audit-log API
AE Profile APIs.io
Wherobots catalogs API
AE Profile APIs.io
Wherobots cloud-connections API
AE Profile APIs.io
Wherobots coupon API
AE Profile APIs.io
Wherobots environment-override--preset API
AE Profile APIs.io
Wherobots environment-preset API
AE Profile APIs.io
Wherobots files API
AE Profile APIs.io
Wherobots Flags API
AE Profile APIs.io
Wherobots foreign-catalog API
AE Profile APIs.io
Wherobots Health API
AE Profile APIs.io
Wherobots Is Super User API
AE Profile APIs.io
#superuser
← Back to W APIs
API Details
ID
wherobots:wherobots-superuser-api
Base URL
https://api.cloud.wherobots.com
Docs
https://docs.wherobots.com/api-playground/
Provider
Wherobots
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network