Viewport daemon, relay, and hosted runtime are available in alpha. Surfaces may change.
VIEWPORT
ReferenceAPI reference

Workflow Routes

9 operations in the Workflow Routes group.

9 of 9 operations on this page are generated contract stubs: the routes are real, the schemas are placeholders pending the owning subsystem's contract pass.

GET /api/workflow-routes

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkflowRoutes

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workflow-routes

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkflowRoutes

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

GET /api/workflow-routes/{workflowRoute}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: getApiWorkflowRoutesWorkflowRoute

Parameters

NameInRequiredTypeDescription
workflowRoutepathyesstring

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PUT /api/workflow-routes/{workflowRoute}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: putApiWorkflowRoutesWorkflowRoute

Parameters

NameInRequiredTypeDescription
workflowRoutepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

PATCH /api/workflow-routes/{workflowRoute}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: patchApiWorkflowRoutesWorkflowRoute

Parameters

NameInRequiredTypeDescription
workflowRoutepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

DELETE /api/workflow-routes/{workflowRoute}

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: deleteApiWorkflowRoutesWorkflowRoute

Parameters

NameInRequiredTypeDescription
workflowRoutepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
204No content
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workflow-routes/{workflowRoute}/versions

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkflowRoutesWorkflowRouteVersions

Parameters

NameInRequiredTypeDescription
workflowRoutepathyesstring

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workflow-routes/dry-run

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkflowRoutesDryRun

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

POST /api/workflow-routes/starter-setup

Generated contract stub — the route is real and served, but its request/response schema has not been hand-tightened yet.

Operation ID: postApiWorkflowRoutesStarterSetup

Request bodyapplication/json · object

Responses

StatusDescriptionSchema
200Successful responseGenericApiResponse
201Successful responseGenericApiResponse
401Authentication is requiredErrorEnvelope
403Permission deniedErrorEnvelope
422Validation failedErrorEnvelope
500Server errorErrorEnvelope

On this page