---
title: "Run a configuration workflow now"
method: POST
path: "/api/south/{southId}/workflows/{workflowId}/run"
tags: ["Configuration Workflows"]
---

# Run a configuration workflow now

`POST /api/south/{southId}/workflows/{workflowId}/run`

Runs a configuration workflow now: discovers the south connector's data source, decides which
discovered entries warrant a change, and acts on them (creating/updating/orphaning items and/or
writing remote point metadata) - on the south connector's live, already-running instance.

## Path parameters

- `southId` string, required
- `workflowId` string, required

## Response `200`

The completed (or errored) run

- WorkflowRunDTO — One execution of a Configuration Workflow - manual or scheduled - reviewable independent of whether anyone was watching.
  - `discoveredCount` number, double, required
  - `eligibleCount` number, double, required
  - `createdCount` number, double, required
  - `updatedCount` number, double, required
  - `disabledCount` number, double, required
  - `pushedCount` number, double, required
  - `id` string, required
  - `workflowId` string, required
  - `triggerType` 'manual' | 'scheduled', required
  - `status` 'RUNNING' | 'ERRORED' | 'COMPLETED', required
  - `startedAt` string, required
  - `completedAt` string, nullable, required — Null while `status` is `RUNNING`.
  - `error` string, nullable, required — Set only when `status` is `ERRORED`.
  - `triggeredBy` UserInfo, required — Represents the user who performed an action, with a computed display name.
    - `id` string, required — The unique identifier of the user.
    - `friendlyName` string, required — A human-readable display name for the user. "OIAnalytics" for the oianalytics system user, "Admin" for the admin login, or "Firstname Lastname (login)" for regular users.

## Changes

- **2026-09-23** `92023a2f20ae` — 1 info
  - endpoint added
- **2026-09-21** `fbefadfe3be3` — 1 breaking
  - api path removed without deprecation
- **2026-09-21** `91dba375a461` — 1 info
  - endpoint added
- **2026-09-21** `52d824185a20` — 1 breaking
  - api path removed without deprecation
- **2026-09-10** `bb379d0410e7` — 1 breaking, 1 info
  - the `triggeredBy` response's property type changed from `string` to no type for status `200`
  - added `#/components/schemas/UserInfo` to the `triggeredBy` response property `allOf` list for the response status `200`

[Full history](https://skmtc.dev/optimistiksas/apis/oibus-api/changes/api/south/:southId/workflows/:workflowId/run/post.md)

---

[API](https://skmtc.dev/optimistiksas/apis/oibus-api.md) · [All operations](https://skmtc.dev/optimistiksas/apis/oibus-api/llms.txt) · [OpenAPI document](https://skmtc.dev/optimistiksas/apis/oibus-api/revisions/a34e6afd34e1?raw)