Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Netflix Conductor Workflow API

The Workflow API from Netflix Conductor — 9 operation(s) for workflow.

Netflix Conductor Workflow API is one of 4 APIs that Netflix Conductor publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 10 operations across 9 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 3.x.

Requests are made against a single base URL, {baseUrl}/api.

10 operations 9 paths 5 schemas 1 DELETE2 GET4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.x
Server
{baseUrl}/api
License
Resource Areas
1

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 1 DELETE, 2 GET, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Workflow 10
POST
/workflow
Start a workflow
startWorkflow body → 200
GET
/workflow/{workflowId}
Get workflow execution
getWorkflow 2 params → 200
DELETE
/workflow/{workflowId}
Terminate a workflow
terminateWorkflow 2 params → 204
PUT
/workflow/{workflowId}/pause
Pause a workflow
pauseWorkflow 1 param → 204
PUT
/workflow/{workflowId}/resume
Resume a workflow
resumeWorkflow 1 param → 204
POST
/workflow/{workflowId}/restart
Restart a workflow
restartWorkflow 2 params → 204
POST
/workflow/{workflowId}/retry
Retry a workflow
retryWorkflow 2 params → 204
POST
/workflow/{workflowId}/rerun
Rerun a workflow
rerunWorkflow 1 param body → 200
PUT
/workflow/{workflowId}/skiptask/{taskReferenceName}
Skip a task
skipTask 2 params → 204
GET
/workflow/search
Search workflows
searchWorkflows 5 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Workflow (14 properties), Task (14 properties), StartWorkflowRequest (7 properties), RerunWorkflowRequest (5 properties). Each schema is shown below with its type and property counts.

SearchResult
object
2 properties
RerunWorkflowRequest
object
5 properties
Task
object
14 properties
StartWorkflowRequest
object
7 properties 1 required
Workflow
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netflix-conductor-workflow-api-openapi.yml Raw ↑

Other APIs Netflix Conductor publishes across the network.

Netflix Conductor Events API
Netflix Conductor Metadata API
Netflix Conductor Tasks API