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

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

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

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

This API exposes 6 operations across 5 paths, and defines 41 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.

6 operations 5 paths 41 schemas 4 GET2 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 runs 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 6

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

runs 6
GET
/runs
List job runs
listJobRuns 6 params → 200400401403404409422500
POST
/runs
Create a job run
createJobRun 1 param body → 201400401403404409422500
GET
/runs/{run_id}
Get a job run
getJobRun 1 param → 200400401403404409422500
POST
/runs/{run_id}/cancel
Cancel a job run
cancelJobRun 1 param → 200400401403404409422500
GET
/runs/{run_id}/logs
Get job run logs
getJobRunLogs 3 params → 200400401403404409422500
GET
/runs/{run_id}/metrics
Get job run metrics
getJobRunMetrics 1 param → 200400401403404409422500

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are RunKubeApp (13 properties), RunView (10 properties), CreateRunPayload-Input (7 properties), CreateRunPayload-Output (7 properties). Each schema is shown below with its type and property counts.

RunEnvironment-Input
object
Model for runtime environment configs, include spark cluster configs, dependencies. When we have new configs like Dax configs, env vars, etc, we can add them h…
4 properties
RunMetricsResponse
object
2 properties 2 required
ErrorInfo
object
7 properties 4 required
InstantMetric
object
2 properties 2 required
RunAppMeta
object
Run-specific metadata fields
3 properties
FileDependency-Output
object
Model for the dependency of a run
3 properties 2 required
RunEnvironment-Output
object
Model for runtime environment configs, include spark cluster configs, dependencies. When we have new configs like Dax configs, env vars, etc, we can add them h…
4 properties
FileDependency-Input
object
Model for the dependency of a run
2 properties 1 required
DataValue
object
2 properties 2 required
AppStatus
string
LogItem
object
2 properties 2 required
Policy
object
7 properties 4 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
RunJarPayload
object
Model for the payload of Run with type == "python"
3 properties 1 required
Provider
string
AppType
string
RunKubeApp
object
13 properties 10 required
Role-Output
object
6 properties 6 required
DataFormat
string
DependencyFileType
string
Enum for the file type of dependency
ErrorBody
object
2 properties 2 required
RunView
object
10 properties 7 required
RunStatus
string
MetricDetails_SeriesMetric_
object
2 properties 2 required
SeriesMetric
object
2 properties 2 required
RuntimeId
string
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
RunPythonPayload
object
Model for the payload of Run with type == "python"
2 properties 1 required
Effect
string
OrganizationCustomer
object
6 properties 4 required
PyPiDependency
object
Model for the dependency of a run
3 properties 1 required
CreateRunPayload-Output
object
7 properties 1 required
RunEventMeta
object
2 properties
DependencySourceType
string
Enum for the source type of dependency
WorkloadMetric
string
MetricDetails_InstantMetric_
object
2 properties 2 required
LogsResponse
object
3 properties 2 required
CreateRunPayload-Input
object
7 properties 1 required
ErrorClass
string
CursorPage__T_Customized_RunView_
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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