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

The sync API from RunWhen — 14 operation(s) for sync.

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

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

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

14 operations 14 paths 6 schemas 6 DELETE8 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 sync 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 14

Across 14 paths, the API surfaces 14 operations — 6 DELETE, 8 POST. Each is listed below with its method, path, parameters, and response codes.

sync 14
POST
/api/v1/workspaces/{workspace_name}/slxs/sync
Upsert an SLX
sync_slx_api_v1_workspaces__workspace_name__slxs_sync_post 1 param body → 200422
DELETE
/api/v1/workspaces/{workspace_name}/slxs/{name}
Soft-delete an SLX
delete_slx_api_v1_workspaces__workspace_name__slxs__name__delete 2 params → 200422
POST
/api/v1/workspaces/{workspace_name}/slxs/reconcile-tasks
[dev only] Re-reconcile slxtasks for a workspace
reconcile_workspace_tasks_api_v1_workspaces__workspace_name__slxs_reconcile_tasks_post 1 param → 200422
POST
/api/v1/workspaces/{workspace_name}/slis/sync
Upsert an SLI
sync_sli_api_v1_workspaces__workspace_name__slis_sync_post 1 param body → 200422
DELETE
/api/v1/workspaces/{workspace_name}/slis/{slx_name}
Soft-delete an SLI by its parent SLX name
delete_sli_api_v1_workspaces__workspace_name__slis__slx_name__delete 2 params → 200422
POST
/api/v1/workspaces/{workspace_name}/slos/sync
Upsert an SLO
sync_slo_api_v1_workspaces__workspace_name__slos_sync_post 1 param body → 200422
DELETE
/api/v1/workspaces/{workspace_name}/slos/{slx_name}
Soft-delete an SLO by its parent SLX name
delete_slo_api_v1_workspaces__workspace_name__slos__slx_name__delete 2 params → 200422
POST
/api/v1/workspaces/{workspace_name}/runbooks/sync
Upsert a Runbook
sync_runbook_api_v1_workspaces__workspace_name__runbooks_sync_post 1 param body → 200422
DELETE
/api/v1/workspaces/{workspace_name}/runbooks/{slx_name}
Soft-delete a Runbook by its parent SLX name
delete_runbook_api_v1_workspaces__workspace_name__runbooks__slx_name__delete 2 params → 200422
POST
/api/v1/workspaces/{workspace_name}/personas/sync
Upsert a Persona
sync_persona_api_v1_workspaces__workspace_name__personas_sync_post 1 param body → 200422
DELETE
/api/v1/workspaces/{workspace_name}/personas/{name}
Soft-delete a Persona
delete_persona_api_v1_workspaces__workspace_name__personas__name__delete 2 params → 200422
POST
/api/v1/workspaces/{workspace_name}/workflows/sync
Upsert a Workflow
sync_workflow_api_v1_workspaces__workspace_name__workflows_sync_post 1 param body → 200422
DELETE
/api/v1/workspaces/{workspace_name}/workflows/{name}
Soft-delete a Workflow
delete_workflow_api_v1_workspaces__workspace_name__workflows__name__delete 2 params → 200422
POST
/api/v1/workspaces/{workspace_name}/sync
Upsert a Workspace
sync_workspace_api_v1_workspaces__workspace_name__sync_post 1 param body → 200422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ValidationError (5 properties), ReconcileTasksResponse (4 properties), DeleteResponse (3 properties), SyncResponse (3 properties). Each schema is shown below with its type and property counts.

ReconcileTasksResponse
object
Response for the dev-only slxtasks reconcile trigger.
4 properties 4 required
SyncRequest
object
Request body for a sync (upsert) operation. modifiedby is not accepted from the request body — the server derives the writer identity from the JWT via :func:sh…
2 properties 1 required
SyncResponse
object
Response for a sync (upsert) operation.
3 properties 2 required
HTTPValidationError
object
1 property
DeleteResponse
object
Response for a soft-delete operation.
3 properties 2 required
ValidationError
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

runwhen-sync-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 sync 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.