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 sql API

The sql API from Wherobots — 3 operation(s) for sql.

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

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

This API exposes 4 operations across 3 paths, and defines 14 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.

4 operations 3 paths 14 schemas 1 DELETE2 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 sql 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 4

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

sql 4
GET
/sql/sessions
Returns a list of the callers SQL sessions
listSqlSessions 1 param → 200400401403404409422500
GET
/sql/session/{session_id}
Returns the callers' SQL session by ID
getSqlSession 1 param → 200400401403404409422500
DELETE
/sql/session/{session_id}
Deletes a SQL session owned by the caller, by ID
deleteSqlSession 1 param → 200400401403404409422500
POST
/sql/session
Creates a SQL session for the user (if needed)
createSqlSession 2 params body → 303400401403404409422500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are SqlSessionKubeApp (13 properties), ErrorInfo (7 properties), SqlSessionAPIPayload (7 properties), KubeAppEvent (6 properties). Each schema is shown below with its type and property counts.

SqlSessionKubeApp
object
13 properties 10 required
ErrorInfo
object
7 properties 4 required
AppType
string
SessionType
string
RuntimeId
string
SqlSessionAppMeta
object
SQL Session-specific metadata fields
2 properties
NodeSchedulingMeta
object
Metadata captured at node-scheduling time. nodepreexisted is True when the pod landed on a node that existed before the pod was created, False when the node wa…
4 properties 4 required
KubeAppEvent
object
6 properties 3 required
AppStatus
string
ErrorClass
string
ErrorBody
object
2 properties 2 required
KubeAppCreationMeta
object
eventmeta shape for EventCode.APPSTARTCREATION. Captures decisions pinned at kubeapp creation time so cancel/destroy can consult them later without re-deriving…
1 property
RunEventMeta
object
2 properties
SqlSessionAPIPayload
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wherobots-sql-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