Update workflow

PUT

/api/v1/workflows/{id}

curl --request PUT \
  --url https://dashboard.justcrawl.io/api/v1/workflows/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "dag": { "nodes": [ { "id": "example", "type": "entry", "config": {} } ], "edges": [ { "id": "example", "from": "example", "to": "example", "type": "default" } ] } }'

• Production

Update a workflow (creates a new version). Returns 400 if the workflow is a smart workflow.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

The workflow ID.

Request Body ^required

Media type application/json

object

name

required

string

dag

required

object

nodes

required

Array<object>

object

id

required

string

type

required

string

Allowed values: entry service split result failed

config

object

edges

required

Array<object>

object

id

required

string

from

required

string

to

required

string

type

required

string

Allowed values: default success fail split

Responses

200

The updated workflow.

Media type application/json

object

workflowId

string format: uuid

name

string

status

string

Allowed values: draft published

version

integer

route

string

nullable

dag

object

nodes

required

Array<object>

object

id

required

string

type

required

string

Allowed values: entry service split result failed

config

object

edges

required

Array<object>

object

id

required

string

from

required

string

to

required

string

type

required

string

Allowed values: default success fail split

costPerThousand

number

nullable

smart

object

strategy

string

Allowed values: success cost reliability

mode

string

Allowed values: auto suggest

domain

string

nullable

hasPendingSuggestion

boolean

createdAt

string format: date-time

Example

{
  "status": "draft",
  "dag": {
    "nodes": [
      {
        "type": "entry"
      }
    ],
    "edges": [
      {
        "type": "default"
      }
    ]
  },
  "smart": {
    "strategy": "success",
    "mode": "auto"
  }
}

400

Smart workflow cannot be edited directly. Clone it first.

404

Workflow not found.