Operator Catalog API
Manages operator definitions, their configurable fields, pipeline DAG structures, and platform entities (users, tenants, engines).
| Field | Value |
|---|---|
| Port | 50001 |
| Base Path | /api/v1 |
| OpenAPI | 3.1.0 |
| Spec | Operators API.json |
Connector/Operator Definitions
CRUD for the operator template catalog — the building blocks users drag onto the pipeline canvas.
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/connector-operators | List all definitions |
| POST | /api/v1/connector-operators | Create definition |
| GET | /api/v1/connector-operators/{id} | Get by ID |
| PUT | /api/v1/connector-operators/{id} | Update definition |
| DELETE | /api/v1/connector-operators/{id} | Soft delete |
| GET | /api/v1/connector-operators/category/{category} | Filter by category |
| GET | /api/v1/connector-operators/type/{type} | Filter by type |
| PATCH | /api/v1/connector-operators/{id}/status | Update status |
| POST | /api/v1/connector-operators/{id}/restore | Restore soft-deleted |
| POST | /api/v1/connector-operators/{id}/purge | Permanently delete |
Operator Field Definitions
Dynamic form fields for each operator — drives the FormRenderer in the portal UI.
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/connector-operators/{operatorId}/fields | List fields for operator |
| POST | /api/v1/connector-operators/{operatorId}/fields | Create field |
| GET | /api/v1/connector-operators/{operatorId}/fields/{fieldId} | Get field |
| PUT | /api/v1/connector-operators/{operatorId}/fields/{fieldId} | Update field |
| DELETE | /api/v1/connector-operators/{operatorId}/fields/{fieldId} | Delete field |
Operator Configurations (User Instances)
When a user configures an operator on the canvas, a config instance is created with their specific values.
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/connector-operator-configs | List configs |
| POST | /api/v1/connector-operator-configs | Create config |
| GET | /api/v1/connector-operator-configs/{id} | Get by ID |
| PUT | /api/v1/connector-operator-configs/{id} | Update config |
| DELETE | /api/v1/connector-operator-configs/{id} | Delete config |
Pipeline Definitions
DAG-level pipeline metadata (not to be confused with the DAG Compiler service which handles compilation/deployment).
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/pipelines | List pipelines |
| POST | /api/v1/pipelines | Create pipeline |
| GET | /api/v1/pipelines/{id} | Get by ID |
| PUT | /api/v1/pipelines/{id} | Update pipeline |
| DELETE | /api/v1/pipelines/{id} | Delete pipeline |
Pipeline Nodes
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/pipelines/{pipelineId}/nodes | List nodes |
| POST | /api/v1/pipelines/{pipelineId}/nodes | Create node |
| GET | /api/v1/pipelines/{pipelineId}/nodes/{nodeId} | Get node |
| PUT | /api/v1/pipelines/{pipelineId}/nodes/{nodeId} | Update node |
| DELETE | /api/v1/pipelines/{pipelineId}/nodes/{nodeId} | Delete node |
Pipeline Edges
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/pipelines/{pipelineId}/edges | List edges |
| POST | /api/v1/pipelines/{pipelineId}/edges | Create edge |
| GET | /api/v1/pipelines/{pipelineId}/edges/{edgeId} | Get edge |
| PUT | /api/v1/pipelines/{pipelineId}/edges/{edgeId} | Update edge |
| DELETE | /api/v1/pipelines/{pipelineId}/edges/{edgeId} | Delete edge |
User Management
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/users | List all users |
| POST | /api/v1/users | Create user |
| GET | /api/v1/users/{id} | Get user |
| PUT | /api/v1/users/{id} | Update user |
| DELETE | /api/v1/users/{id} | Delete user |
Tenant Management
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/tenants | List all tenants |
| POST | /api/v1/tenants | Create tenant |
| GET | /api/v1/tenants/{id} | Get tenant |
| PUT | /api/v1/tenants/{id} | Update tenant |
| DELETE | /api/v1/tenants/{id} | Delete tenant |
Additional Domain Groups
All follow standard CRUD patterns:
| Domain | Base Path |
|---|---|
| Operator Stage Definitions | /api/v1/connector-operators/{id}/stages |
| Stage Field Definitions | /api/v1/connector-operators/{id}/stages/{stageId}/fields |
| Stage Connections | /api/v1/connector-operators/{id}/stages/connections |
| Engine Mappings | /api/v1/connector-operators/{id}/engines |
| Platform Engines | /api/v1/engines |
| Encryption Algorithms | /api/v1/encryption-algorithms |
| Pipeline Event Store | /api/v1/pipelines/{id}/events |
| Execution Instances | /api/v1/pipelines/{id}/executions |
Frontend Integration
| File | Purpose |
|---|---|
services/operators/operator.service.ts | Operator template fetching |
types/operator.types.ts | TypeScript type definitions |
services/operators/useOperators.ts | React Query hook |