RunWhen

RunWhen Workspaces API

The workspaces API from RunWhen — 72 operation(s) for workspaces.

GitHub OpenAPI

Operations 80

GET /api/v1/workspaces List workspaces for the current user #
POST /api/v1/workspaces Create a new workspace #
GET /api/v1/workspaces/{workspace_short_name} Get a workspace by name #
GET /api/v1/workspaces/provisioning-status/{workspace_name} Get workspace provisioning progress #
PATCH /api/v1/workspaces/{workspace_name} Update a workspace #
DELETE /api/v1/workspaces/{workspace_name} Delete a workspace #
GET /api/v1/workspaces/{workspace_name}/workspace-configuration-index Get workspace configuration index #
GET /api/v1/workspaces/{workspace_name}/metadata Get workspace metadata from sobow #
GET /api/v1/workspaces/{workspace_name}/entities Get workspace entities #
GET /api/v1/workspaces/{workspace_name}/index-health Get workspace index health #
GET /api/v1/workspaces/{workspace_name}/status Get workspace creation status #
GET /api/v1/workspaces/{workspace_name}/my-permissions Get current user's permissions on workspace #
GET /api/v1/workspaces/{workspace_name}/sync-status Get workspace sync status from WorkSync CRD #
GET /api/v1/workspaces/{workspace_name}/secrets-keys List workspace secret keys #
POST /api/v1/workspaces/{workspace_name}/secrets Create or update workspace secrets #
DELETE /api/v1/workspaces/{workspace_name}/secrets/{secret_key} Delete a single workspace secret #
GET /api/v1/workspaces/{workspace_name}/secrets/{secret_key}/usage List where a workspace secret is used #
POST /api/v1/workspaces/{workspace_name}/reset-service-account Reset or create workspace service account #
GET /api/v1/workspaces/{workspace_name}/sa-token Get workspace service account token #
GET /api/v1/workspaces/{workspace_name}/get-gitlab-sas Get GitLab service accounts for workspace #
POST /api/v1/workspaces/{workspace_name}/task-search Search workspace tasks #
POST /api/v1/workspaces/{workspace_name}/autocomplete Autocomplete for task search #
GET /api/v1/workspaces/{workspace_name}/runners Get runners #
GET /api/v1/workspaces/{workspace_name}/generate-workspace-builder-config [DEPRECATED] Generate workspace builder config #
GET /api/v1/workspaces/{workspace_name}/search-scope Get search scope options #
GET /api/v1/workspaces/{workspace_name}/upload-config Generate upload config for a location #
GET /api/v1/workspaces/{workspace_name}/internal/upload-config Generate upload config (internal) #
GET /api/v1/workspaces/{workspace_name}/runner-token Get runner registration token #
GET /api/v1/workspaces/{workspace_name}/anonymous-mode Get anonymous mode status #
POST /api/v1/workspaces/{workspace_name}/anonymous-mode Toggle anonymous mode #
GET /api/v1/workspaces/{workspace_short_name}/workspace-stats Get workspace statistics #
GET /api/v1/workspaces/{workspace_short_name}/top-issue-resources Get top resources by issue count #
GET /api/v1/workspaces/{workspace_name}/agentfarm-params Get AgentFarm parameters for a workspace #
GET /api/v1/workspaces/{workspace_name}/activities Get workspace activity feed #
DELETE /api/v1/workspaces/{workspace_name}/runners/{runner_id} Delete a runner #
GET /api/v1/workspaces/{workspace_name}/layout Get workspace layout #
POST /api/v1/workspaces/{workspace_name}/layout Save workspace layout #
POST /api/v1/workspaces/{workspace_name}/reprovision-workspace-infra Reprovision workspace runner infrastructure (staff only) #
POST /api/v1/workspaces/{workspace_short_name}/upload Upload workspace archive #
GET /api/v1/workspaces/upload-status/{task_id} Check upload task status #
POST /api/v3/workspaces/{workspace_short_name}/upload Upload workspace archive #
GET /api/v3/workspaces/upload-status/{task_id} Check upload task status #
GET /api/v3/workspaces List workspaces for the current user #
POST /api/v3/workspaces Create a new workspace #
GET /api/v3/workspaces/{workspace_short_name} Get a workspace by name #
GET /api/v3/workspaces/provisioning-status/{workspace_name} Get workspace provisioning progress #
PATCH /api/v3/workspaces/{workspace_name} Update a workspace #
DELETE /api/v3/workspaces/{workspace_name} Delete a workspace #
GET /api/v3/workspaces/{workspace_name}/workspace-configuration-index Get workspace configuration index #
GET /api/v3/workspaces/{workspace_name}/metadata Get workspace metadata from sobow #
GET /api/v3/workspaces/{workspace_name}/entities Get workspace entities #
GET /api/v3/workspaces/{workspace_name}/index-health Get workspace index health #
GET /api/v3/workspaces/{workspace_name}/status Get workspace creation status #
GET /api/v3/workspaces/{workspace_name}/my-permissions Get current user's permissions on workspace #
GET /api/v3/workspaces/{workspace_name}/sync-status Get workspace sync status from WorkSync CRD #
GET /api/v3/workspaces/{workspace_name}/secrets-keys List workspace secret keys #
POST /api/v3/workspaces/{workspace_name}/secrets Create or update workspace secrets #
DELETE /api/v3/workspaces/{workspace_name}/secrets/{secret_key} Delete a single workspace secret #
GET /api/v3/workspaces/{workspace_name}/secrets/{secret_key}/usage List where a workspace secret is used #
POST /api/v3/workspaces/{workspace_name}/reset-service-account Reset or create workspace service account #
GET /api/v3/workspaces/{workspace_name}/sa-token Get workspace service account token #
GET /api/v3/workspaces/{workspace_name}/get-gitlab-sas Get GitLab service accounts for workspace #
POST /api/v3/workspaces/{workspace_name}/task-search Search workspace tasks #
POST /api/v3/workspaces/{workspace_name}/autocomplete Autocomplete for task search #
GET /api/v3/workspaces/{workspace_name}/runners Get runners #
GET /api/v3/workspaces/{workspace_name}/generate-workspace-builder-config [DEPRECATED] Generate workspace builder config #
GET /api/v3/workspaces/{workspace_name}/search-scope Get search scope options #
GET /api/v3/workspaces/{workspace_name}/upload-config Generate upload config for a location #
GET /api/v3/workspaces/{workspace_name}/internal/upload-config Generate upload config (internal) #
GET /api/v3/workspaces/{workspace_name}/runner-token Get runner registration token #
GET /api/v3/workspaces/{workspace_name}/anonymous-mode Get anonymous mode status #
POST /api/v3/workspaces/{workspace_name}/anonymous-mode Toggle anonymous mode #
GET /api/v3/workspaces/{workspace_short_name}/workspace-stats Get workspace statistics #
GET /api/v3/workspaces/{workspace_short_name}/top-issue-resources Get top resources by issue count #
GET /api/v3/workspaces/{workspace_name}/agentfarm-params Get AgentFarm parameters for a workspace #
GET /api/v3/workspaces/{workspace_name}/activities Get workspace activity feed #
DELETE /api/v3/workspaces/{workspace_name}/runners/{runner_id} Delete a runner #
GET /api/v3/workspaces/{workspace_name}/layout Get workspace layout #
POST /api/v3/workspaces/{workspace_name}/layout Save workspace layout #
POST /api/v3/workspaces/{workspace_name}/reprovision-workspace-infra Reprovision workspace runner infrastructure (staff only) #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/runwhen/refs/heads/main/openapi/runwhen-workspaces-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/runwhen-workspaces-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

runwhen-workspaces-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: papi Workspaces API
  description: RunWhen Platform API
  version: 2.0.0
tags:


# --- truncated at 32 KB (149 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/runwhen/refs/heads/main/openapi/runwhen-workspaces-api-openapi.yml