Skip to content

Publish workflow

POST
/api/v1/workflows/{id}/publish
Code sample: cURL
curl -X POST 'https://dashboard.justcrawl.io/api/v1/workflows/a47ac10b-58cc-4372-a567-0e02b2c3d479/publish' \
-H 'Authorization: Bearer $JUSTCRAWL_API_KEY'

Validate the workflow’s latest version and flip its status to published. Once published, the workflow is eligible to receive dispatched scrape jobs (resolution still depends on route). Returns 400 with validationErrors if the DAG fails structural validation — re-edit, fix the errors, then retry.

id
required
string format: uuid

The workflow ID.

Workflow status flipped to published.

Media type application/json
object
workflowId
string format: uuid
status
string
Allowed values: published
Example
{
"status": "published"
}

Workflow DAG has validation errors that prevented publish. Body includes a validationErrors array.

Media type application/json
object
error
string
validationErrors
Array<object>
object
Example generated
{
"error": "example",
"validationErrors": [
{}
]
}

Missing or invalid authentication token

Media type application/json
object
error
string
Example
{
"error": "Missing or invalid authentication token"
}

Insufficient permissions for this operation

Media type application/json
object
error
string
Example
{
"error": "No organization. Complete onboarding first."
}

Resource not found

Media type application/json
object
error
string
Example
{
"error": "Workflow not found"
}

Unexpected server error. Logs and PostHog $exception capture

Media type application/json
object
error
string
Example
{
"error": "Something went wrong"
}