NUnullplatform
Workflow definitions

Validate a definition

Changed on

Dry-run validation of a definition (graph shape plus step configs) with no writes. Always returns 200; inspect valid and errors.

post/workflows/definitions/{id}/validate

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/workflows/definitions/{id}/validate
  • Auth
    HTTP bearer

Path parameters

idstring required

Workflow reference: a server-minted id (wf_...) or the workflow's client-chosen key (lowercase slug, unique per organization).

Request body

namestring required

Human-readable workflow name.

keystring

Client-chosen slug (^[a-z0-9][a-z0-9-]{0,62}$), unique per organization and immutable. Enables GitOps-style upserts via PUT /workflows/definitions/{key}.

descriptionstring
pathstring

Folder in the workflows tree. Defaults to /.

nrnstring

The nullplatform resource name the workflow is scoped to. Defaults to the caller's organization.

stepsobject required

Map of step id to step definition. Step ids are alphanumeric (no hyphens).

connectionsobject[]

Edges between steps.

variablesobject

Per-run variables with optional initialValue.

metadataobject
semanticVersionstring

Optional version label stored on the revision.

Example request

{
  "name": "AMI drift scanner",
  "key": "ami-drift-scanner",
  "description": "Scans deployed scopes for outdated AMIs.",
  "path": "/action-items/ami-drift",
  "semanticVersion": "1.2.0"
}

Response

The validation verdict, valid or not.

validboolean

Example response

{
  "errors": [
    {
      "path": "/steps/scan"
    }
  ]
}

Changes