How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RunWhen workspaces API

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

RunWhen workspaces API is one of 51 APIs that RunWhen publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 80 operations across 72 paths, and defines 55 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://papi.beta.runwhen.com.

80 operations 72 paths 55 schemas 6 DELETE54 GET2 PATCH18 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://papi.beta.runwhen.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

RunWhen workspaces API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

  • BearerAuth — JWT access token from /api/v3/token/ or Auth0 login

Paths & Operations 80

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

workspaces 80
GET
/api/v1/workspaces
List workspaces for the current user
list_workspaces_api_v1_workspaces_get 2 params → 200422
POST
/api/v1/workspaces
Create a new workspace
create_workspace_api_v1_workspaces_post body → 201422
GET
/api/v1/workspaces/{workspace_short_name}
Get a workspace by name
get_workspace_api_v1_workspaces__workspace_short_name__get 2 params → 200422
GET
/api/v1/workspaces/provisioning-status/{workspace_name}
Get workspace provisioning progress
provisioning_status_api_v1_workspaces_provisioning_status__workspace_name__get 1 param → 200422
PATCH
/api/v1/workspaces/{workspace_name}
Update a workspace
update_workspace_api_v1_workspaces__workspace_name__patch 1 param body → 200422
DELETE
/api/v1/workspaces/{workspace_name}
Delete a workspace
delete_workspace_api_v1_workspaces__workspace_name__delete 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/workspace-configuration-index
Get workspace configuration index
get_workspace_configuration_index_api_v1_workspaces__workspace_name__workspace_configuration_index_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/metadata
Get workspace metadata from sobow
get_workspace_metadata_api_v1_workspaces__workspace_name__metadata_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/entities
Get workspace entities
get_workspace_entities_api_v1_workspaces__workspace_name__entities_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/index-health
Get workspace index health
get_workspace_index_health_api_v1_workspaces__workspace_name__index_health_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/status
Get workspace creation status
get_workspace_status_api_v1_workspaces__workspace_name__status_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/my-permissions
Get current user's permissions on workspace
get_my_permissions_api_v1_workspaces__workspace_name__my_permissions_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/sync-status
Get workspace sync status from WorkSync CRD
get_workspace_sync_status_api_v1_workspaces__workspace_name__sync_status_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/secrets-keys
List workspace secret keys
get_workspace_secret_keys_api_v1_workspaces__workspace_name__secrets_keys_get 1 param → 200422
POST
/api/v1/workspaces/{workspace_name}/secrets
Create or update workspace secrets
create_workspace_secrets_api_v1_workspaces__workspace_name__secrets_post 1 param body → 201422
DELETE
/api/v1/workspaces/{workspace_name}/secrets/{secret_key}
Delete a single workspace secret
delete_workspace_secret_api_v1_workspaces__workspace_name__secrets__secret_key__delete 2 params → 200422
GET
/api/v1/workspaces/{workspace_name}/secrets/{secret_key}/usage
List where a workspace secret is used
get_workspace_secret_usage_api_v1_workspaces__workspace_name__secrets__secret_key__usage_get 2 params → 200422
POST
/api/v1/workspaces/{workspace_name}/reset-service-account
Reset or create workspace service account
reset_workspace_service_account_api_v1_workspaces__workspace_name__reset_service_account_post 1 param body → 201422
GET
/api/v1/workspaces/{workspace_name}/sa-token
Get workspace service account token
get_workspace_sa_token_api_v1_workspaces__workspace_name__sa_token_get 3 params → 200422
GET
/api/v1/workspaces/{workspace_name}/get-gitlab-sas
Get GitLab service accounts for workspace
get_gitlab_service_accounts_api_v1_workspaces__workspace_name__get_gitlab_sas_get 1 param → 200422
POST
/api/v1/workspaces/{workspace_name}/task-search
Search workspace tasks
search_workspace_tasks_api_v1_workspaces__workspace_name__task_search_post 1 param body → 200422
POST
/api/v1/workspaces/{workspace_name}/autocomplete
Autocomplete for task search
autocomplete_workspace_search_api_v1_workspaces__workspace_name__autocomplete_post 1 param body → 200422
GET
/api/v1/workspaces/{workspace_name}/runners
Get runners
get_runners_api_v1_workspaces__workspace_name__runners_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/generate-workspace-builder-configdeprecated
[DEPRECATED] Generate workspace builder config
generate_workspace_builder_config_api_v1_workspaces__workspace_name__generate_workspace_builder_config_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/search-scope
Get search scope options
get_search_scope_api_v1_workspaces__workspace_name__search_scope_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_name}/upload-config
Generate upload config for a location
get_upload_config_api_v1_workspaces__workspace_name__upload_config_get 2 params → 200422
GET
/api/v1/workspaces/{workspace_name}/internal/upload-config
Generate upload config (internal)
get_internal_upload_config_api_v1_workspaces__workspace_name__internal_upload_config_get 2 params → 200422
GET
/api/v1/workspaces/{workspace_name}/runner-token
Get runner registration token
get_runner_token_api_v1_workspaces__workspace_name__runner_token_get 2 params → 200422
GET
/api/v1/workspaces/{workspace_name}/anonymous-mode
Get anonymous mode status
get_anonymous_mode_status_api_v1_workspaces__workspace_name__anonymous_mode_get 1 param → 200422
POST
/api/v1/workspaces/{workspace_name}/anonymous-mode
Toggle anonymous mode
toggle_anonymous_mode_api_v1_workspaces__workspace_name__anonymous_mode_post 1 param body → 200422
GET
/api/v1/workspaces/{workspace_short_name}/workspace-stats
Get workspace statistics
workspace_stats_api_v1_workspaces__workspace_short_name__workspace_stats_get 1 param → 200422
GET
/api/v1/workspaces/{workspace_short_name}/top-issue-resources
Get top resources by issue count
top_issue_resources_api_v1_workspaces__workspace_short_name__top_issue_resources_get 3 params → 200422
GET
/api/v1/workspaces/{workspace_name}/agentfarm-params
Get AgentFarm parameters for a workspace
agentfarm_params_api_v1_workspaces__workspace_name__agentfarm_params_get 2 params → 200422
GET
/api/v1/workspaces/{workspace_name}/activities
Get workspace activity feed
get_workspace_activities_api_v1_workspaces__workspace_name__activities_get 1 param → 200422
DELETE
/api/v1/workspaces/{workspace_name}/runners/{runner_id}
Delete a runner
delete_runner_api_v1_workspaces__workspace_name__runners__runner_id__delete 2 params → 200422
GET
/api/v1/workspaces/{workspace_name}/layout
Get workspace layout
get_workspace_layout_api_v1_workspaces__workspace_name__layout_get 2 params → 200422
POST
/api/v1/workspaces/{workspace_name}/layout
Save workspace layout
save_workspace_layout_api_v1_workspaces__workspace_name__layout_post 2 params → 201422
POST
/api/v1/workspaces/{workspace_name}/reprovision-workspace-infra
Reprovision workspace runner infrastructure (staff only)
reprovision_workspace_infra_api_v1_workspaces__workspace_name__reprovision_workspace_infra_post 1 param → 200422
POST
/api/v1/workspaces/{workspace_short_name}/upload
Upload workspace archive
upload_workspace_api_v1_workspaces__workspace_short_name__upload_post 1 param body → 200422
GET
/api/v1/workspaces/upload-status/{task_id}
Check upload task status
get_upload_status_api_v1_workspaces_upload_status__task_id__get 1 param → 200422
POST
/api/v3/workspaces/{workspace_short_name}/upload
Upload workspace archive
upload_workspace_api_v3_workspaces__workspace_short_name__upload_post 1 param body → 200422
GET
/api/v3/workspaces/upload-status/{task_id}
Check upload task status
get_upload_status_api_v3_workspaces_upload_status__task_id__get 1 param → 200422
GET
/api/v3/workspaces
List workspaces for the current user
list_workspaces_api_v3_workspaces_get 2 params → 200422
POST
/api/v3/workspaces
Create a new workspace
create_workspace_api_v3_workspaces_post body → 201422
GET
/api/v3/workspaces/{workspace_short_name}
Get a workspace by name
get_workspace_api_v3_workspaces__workspace_short_name__get 2 params → 200422
GET
/api/v3/workspaces/provisioning-status/{workspace_name}
Get workspace provisioning progress
provisioning_status_api_v3_workspaces_provisioning_status__workspace_name__get 1 param → 200422
PATCH
/api/v3/workspaces/{workspace_name}
Update a workspace
update_workspace_api_v3_workspaces__workspace_name__patch 1 param body → 200422
DELETE
/api/v3/workspaces/{workspace_name}
Delete a workspace
delete_workspace_api_v3_workspaces__workspace_name__delete 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/workspace-configuration-index
Get workspace configuration index
get_workspace_configuration_index_api_v3_workspaces__workspace_name__workspace_configuration_index_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/metadata
Get workspace metadata from sobow
get_workspace_metadata_api_v3_workspaces__workspace_name__metadata_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/entities
Get workspace entities
get_workspace_entities_api_v3_workspaces__workspace_name__entities_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/index-health
Get workspace index health
get_workspace_index_health_api_v3_workspaces__workspace_name__index_health_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/status
Get workspace creation status
get_workspace_status_api_v3_workspaces__workspace_name__status_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/my-permissions
Get current user's permissions on workspace
get_my_permissions_api_v3_workspaces__workspace_name__my_permissions_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/sync-status
Get workspace sync status from WorkSync CRD
get_workspace_sync_status_api_v3_workspaces__workspace_name__sync_status_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/secrets-keys
List workspace secret keys
get_workspace_secret_keys_api_v3_workspaces__workspace_name__secrets_keys_get 1 param → 200422
POST
/api/v3/workspaces/{workspace_name}/secrets
Create or update workspace secrets
create_workspace_secrets_api_v3_workspaces__workspace_name__secrets_post 1 param body → 201422
DELETE
/api/v3/workspaces/{workspace_name}/secrets/{secret_key}
Delete a single workspace secret
delete_workspace_secret_api_v3_workspaces__workspace_name__secrets__secret_key__delete 2 params → 200422
GET
/api/v3/workspaces/{workspace_name}/secrets/{secret_key}/usage
List where a workspace secret is used
get_workspace_secret_usage_api_v3_workspaces__workspace_name__secrets__secret_key__usage_get 2 params → 200422
POST
/api/v3/workspaces/{workspace_name}/reset-service-account
Reset or create workspace service account
reset_workspace_service_account_api_v3_workspaces__workspace_name__reset_service_account_post 1 param body → 201422
GET
/api/v3/workspaces/{workspace_name}/sa-token
Get workspace service account token
get_workspace_sa_token_api_v3_workspaces__workspace_name__sa_token_get 3 params → 200422
GET
/api/v3/workspaces/{workspace_name}/get-gitlab-sas
Get GitLab service accounts for workspace
get_gitlab_service_accounts_api_v3_workspaces__workspace_name__get_gitlab_sas_get 1 param → 200422
POST
/api/v3/workspaces/{workspace_name}/task-search
Search workspace tasks
search_workspace_tasks_api_v3_workspaces__workspace_name__task_search_post 1 param body → 200422
POST
/api/v3/workspaces/{workspace_name}/autocomplete
Autocomplete for task search
autocomplete_workspace_search_api_v3_workspaces__workspace_name__autocomplete_post 1 param body → 200422
GET
/api/v3/workspaces/{workspace_name}/runners
Get runners
get_runners_api_v3_workspaces__workspace_name__runners_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/generate-workspace-builder-configdeprecated
[DEPRECATED] Generate workspace builder config
generate_workspace_builder_config_api_v3_workspaces__workspace_name__generate_workspace_builder_config_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/search-scope
Get search scope options
get_search_scope_api_v3_workspaces__workspace_name__search_scope_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_name}/upload-config
Generate upload config for a location
get_upload_config_api_v3_workspaces__workspace_name__upload_config_get 2 params → 200422
GET
/api/v3/workspaces/{workspace_name}/internal/upload-config
Generate upload config (internal)
get_internal_upload_config_api_v3_workspaces__workspace_name__internal_upload_config_get 2 params → 200422
GET
/api/v3/workspaces/{workspace_name}/runner-token
Get runner registration token
get_runner_token_api_v3_workspaces__workspace_name__runner_token_get 2 params → 200422
GET
/api/v3/workspaces/{workspace_name}/anonymous-mode
Get anonymous mode status
get_anonymous_mode_status_api_v3_workspaces__workspace_name__anonymous_mode_get 1 param → 200422
POST
/api/v3/workspaces/{workspace_name}/anonymous-mode
Toggle anonymous mode
toggle_anonymous_mode_api_v3_workspaces__workspace_name__anonymous_mode_post 1 param body → 200422
GET
/api/v3/workspaces/{workspace_short_name}/workspace-stats
Get workspace statistics
workspace_stats_api_v3_workspaces__workspace_short_name__workspace_stats_get 1 param → 200422
GET
/api/v3/workspaces/{workspace_short_name}/top-issue-resources
Get top resources by issue count
top_issue_resources_api_v3_workspaces__workspace_short_name__top_issue_resources_get 3 params → 200422
GET
/api/v3/workspaces/{workspace_name}/agentfarm-params
Get AgentFarm parameters for a workspace
agentfarm_params_api_v3_workspaces__workspace_name__agentfarm_params_get 2 params → 200422
GET
/api/v3/workspaces/{workspace_name}/activities
Get workspace activity feed
get_workspace_activities_api_v3_workspaces__workspace_name__activities_get 1 param → 200422
DELETE
/api/v3/workspaces/{workspace_name}/runners/{runner_id}
Delete a runner
delete_runner_api_v3_workspaces__workspace_name__runners__runner_id__delete 2 params → 200422
GET
/api/v3/workspaces/{workspace_name}/layout
Get workspace layout
get_workspace_layout_api_v3_workspaces__workspace_name__layout_get 2 params → 200422
POST
/api/v3/workspaces/{workspace_name}/layout
Save workspace layout
save_workspace_layout_api_v3_workspaces__workspace_name__layout_post 2 params → 201422
POST
/api/v3/workspaces/{workspace_name}/reprovision-workspace-infra
Reprovision workspace runner infrastructure (staff only)
reprovision_workspace_infra_api_v3_workspaces__workspace_name__reprovision_workspace_infra_post 1 param → 200422

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are WorkspaceResponse (33 properties), SlxInWorkspace (15 properties), SearchScopeSlx (10 properties), SloAlertInWorkspace (9 properties). Each schema is shown below with its type and property counts.

TaskSearchRequest
object
Request for workspace task search.
4 properties 1 required
WorkspaceSpec
object
Workspace spec (reconstructed from individual columns for UI compatibility). The Django model stores all these in a body.spec JSON field. The FastAPI model sto…
8 properties
SearchScopeResponse
object
Search scope response.
3 properties
SloAlertInWorkspace
object
SLO firing alert for workspace response.
9 properties 4 required
HTTPValidationError
object
1 property
WorkspaceUpdate
object
Schema for updating a workspace (partial update). All fields are optional; only non-None values are applied.
8 properties
MergeModeEnum
string
Merge mode for workspace upload.
SecretsKeysResponse
object
Response containing list of secret key names.
1 property
SecretDeleteResponse
object
Response after deleting a single workspace secret.
3 properties 2 required
_ProvisioningStages
object
6 properties
SlxSpecInWorkspace
object
SLX spec for workspace response (matches frontend SlxSpec interface).
8 properties
RunbookInWorkspace
object
Runbook schema for workspace response with tasks.
6 properties 3 required
AnonymousModeResponse
object
Response for anonymous mode toggle.
3 properties 3 required
AnonymousModeRequest
object
Request body for toggling anonymous mode.
1 property 1 required
UploadConfigResponse
object
Response containing upload credentials and PAPI URL for workspace-builder.
2 properties 2 required
ReprovisionWorkspaceInfraResponse
object
Response from reprovisioning workspace runner infrastructure.
3 properties 3 required
WorkspaceUploadResponse
object
Schema for workspace upload response.
3 properties 1 required
WorkspacePermissionUpdate
object
A single permission entry for workspace update requests. Mirrors WorkspaceSpecPermission but is used for incoming PATCH payloads. Either user (email) or group…
3 properties 1 required
WorkspaceSpecPermission
object
AutocompleteRequest
object
Request for search autocomplete.
1 property 1 required
ResetServiceAccountResponse
object
Response from resetting a service account.
2 properties 1 required
OwnerResponse
object
Schema for owner info in workspace response.
3 properties 1 required
GalleryUser
object
Schema for user info in workspace gallery.
3 properties 1 required
UploadStatusResponse
object
Schema for upload status check response.
4 properties 2 required
WorkspaceUploadRequest
object
Schema for workspace upload request (matches runner format).
7 properties 1 required
RunbookTaskInWorkspace
object
Individual task in a runbook for workspace response.
4 properties 2 required
ResourceScrubberConfigEnum
string
Configuration for resource scrubbing before LLM calls.
GalleryPersona
object
Schema for persona info in workspace gallery.
3 properties 2 required
SecretUsageResponse
object
Response listing where a workspace secret is referenced.
2 properties 1 required
ResetServiceAccountRequest
object
Request to reset a workspace service account password.
1 property 1 required
WorkspaceStatusResponse
object
Response for workspace creation status check.
2 properties 2 required
WorkspaceGitCreate
object
Schema for Git-first workspace creation.
2 properties 1 required
SlxTag
object
Tag with name-value structure for SLX.
2 properties 2 required
SecretsCreateResponse
object
Response after creating/updating secrets.
3 properties
SloBasicInWorkspace
object
Basic SLO info for workspace SLX response (matches Django SloSerializer).
8 properties 3 required
_ProvisioningStatusResponse
object
4 properties
ValidationError
object
5 properties 3 required
SecretsCreateRequest
object
Request to create/update workspace secrets.
1 property 1 required
SearchScopeSlx
object
SLX item in search scope.
10 properties 3 required
WorkspaceListResponse
object
Schema for paginated workspace list response.
4 properties 2 required
WorkspaceCreateResponse
object
Response for workspace creation. Synchronous creation returns status="ready". Async GitOps-based creation (if re-enabled) returns status="provisioning" and req…
4 properties 3 required
WorkspaceDeletionResponse
object
Response from workspace deletion endpoint.
4 properties 3 required
DeletionStep
object
Status of a single deletion step.
4 properties 3 required
FinalizeActionEnum
string
Finalize action after workspace upload.
WorkspaceResponse
object
Schema for workspace response with all fields (camelCase for UI).
33 properties 2 required
AnonymousModeStatusResponse
object
Response for anonymous mode status check.
2 properties 2 required
SearchScopeGroup
object
SLX group in search scope.
3 properties 1 required
SATokenResponse
object
Response containing a service account token.
1 property 1 required
WorkspaceRoleEnum
string
Workspace permission roles.
SecretUsageItem
object
A single SLI/Runbook that references a workspace secret.
3 properties 3 required
SlxInWorkspace
object
SLX summary for workspace response (camelCase for UI compatibility).
15 properties 3 required
SliAlertInWorkspace
object
SLI firing alert for workspace response.
7 properties 4 required
SliBasicInWorkspace
object
Basic SLI info for workspace SLX response (matches Django SliSerializer).
5 properties 3 required
AuthorizedRunner
object
Authorized runner for a workspace.
5 properties 2 required
RunSessionCount
object
Schema for run session count by date.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runwhen-workspaces-api-openapi.yml Raw ↑

Other APIs RunWhen publishes across the network.

RunWhen alert-query-proxy API
RunWhen auth API
RunWhen auth-providers API
RunWhen auth0 API
RunWhen author API
RunWhen chat-config API
RunWhen codebundles API
RunWhen codecollections API
RunWhen comments API
RunWhen configuration API
RunWhen explorer API
RunWhen Graphql API
Where this information came from

This is an independent, third-party profile of RunWhen workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.