ci.workflows.validate

Check a workflow file against the parser without pushing it

POST /ci/api/workflows/validateIAM ci:ListRunsRead

The same parser a push runs. Answers `{ valid, issues }`; each issue names the key and, where the source allowed it, the line.

Request syntax

POST /ci/api/workflows/validate
{
  "source": "string",
  "path": "string"
}

Request body

  • sourceRequired

    string

    The workflow file’s content, YAML (or JSON), 1 to 65,536 characters

    Constraints: 1-65536 chars

  • pathOptional

    string

    Where the file will live, up to 500 characters; under .github/workflows/ it is checked as GitHub Actions; elsewhere or omitted: as the native format

    Constraints: 1-500 chars

Response

200 with { valid, issues }: issues is a list of strings, each prefixed "line N:" where the parser knows the line; empty when valid. An invalid file is still 200. 403 without ci:ListRuns on the service.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow ci:ListRuns on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud ci workflows validate --source example

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_ci_workflows_validate.