Information
- OpenAPI version:
3.1.0
Overview
Blotout Platform API 0.1.0
Section titled “Blotout Platform API 0.1.0”HTTP API for programmatic access to Blotout platform teams and their resources.
Protected operations accept a team API token or OAuth access token sent as Authorization: Bearer <token>. The health check and the OAuth metadata, token, and revocation operations do not require a bearer token. Call GET /me to confirm a credential works and to discover the teamId other operations need.
Outside the OAuth group, errors use one JSON envelope: error is a machine-readable slug to switch on, message optionally carries a human-readable reason, and details optionally carries field-level validation errors. The OAuth endpoints use the standard OAuth shape instead — error with error_description — and the unauthenticated health check reports { status: "error" }. Success payloads are documented per operation.
Authentication
Section titled “Authentication”QintoAccessToken
Section titled “QintoAccessToken”Opaque API token, sent on every request as Authorization: Bearer <token>. Generate one from the Blotout platform’s Team → API tokens page. Each token is bound to one team and carries only its selected policies.
Security scheme type: http
Categories
SystemOperational endpoints used to check whether the Blotout platform API and its dependencies are available.UserThe identity behind the presented access token: who is calling, which team the token is bound to, and what access it carries.HostsCloudflare account connections that a team uses to provision and operate domains.SitesThe sites a team serves through Qinto: creating one, publishing its DNS, choosing where it is delivered from, deploying it, retrieving the snippet to install, and setting bot protection and automatic capture.Site analyticsWhat a site’s apps did over a time range: event counts by status, event or install, error counts per install, and the errors themselves.Site appsApps installed on a site: what runs there, each install’s state, extra installs, and the install, version, enable, and uninstall operations.App storeThe catalog of approved apps a team can browse: searching it by words or category, and reading one app’s listing and what its newest approved version may do.Bundle purchasesThe bundles a team bought: buying one from the app store or through a bundle link for the sites the team chooses, and listing what the team holds.TeamsThe team a bearer credential is bound to, and the starting point for every other operation.Team membersTeam roster and user identity endpoints for resolving the people who belong to a team.BillingWhat a team pays for the Blotout platform: this month’s core usage charges and projection, each site’s share, the next charge date, the payment terms and past invoices.Storage linksConfigurations that let several of a team’s sites share one site’s storage — the identity graph and app storage — chosen per child site, per resource.Developer appsApps an organization builds for Qinto sites: registering them, managing their metadata, and deleting themDeveloper bundlesOffers that sell several of an organization’s apps together: creating Drafts, editing them, and deleting them.OAuthThe OAuth 2.1 authorization-server endpoints external apps use to obtain and manage qoa_ access tokens on behalf of the users who authorize them.