---
title: "Validate Workflow Entrypoint"
method: POST
path: "/workspaces/{workspace_id}/workflows/validate-entrypoint"
tags: ["workflows"]
---

# Validate Workflow Entrypoint

`POST /workspaces/{workspace_id}/workflows/validate-entrypoint`

## Request

- Base URL: `https://platform.tracecat.com/api`
- URL: `https://platform.tracecat.com/api/workspaces/{workspace_id}/workflows/validate-entrypoint`
- Auth: one of:
  - API key in cookie `fastapiusersauth`
  - HTTP bearer

Validate a workflow entrypoint expects definition.

## Path parameters

- `workspace_id` string, uuid, required

## Request body

- WorkflowEntrypointValidationRequest
  - `expects` object, nullable

## Response `200`

Successful Response

- WorkflowEntrypointValidationResponse
  - `valid` boolean, required
  - `errors` ValidationResult[]
    - union
      - DSLValidationResult: Result of validating a generic input.
        - `type` 'dsl'
        - `status` 'success' | 'error', required
        - `msg` string
        - `detail` ValidationDetail[], nullable
          - `type` string, required
          - `msg` string, required
          - `loc` union[], nullable
            - union
              - …
        - `ref` string, nullable
      - SecretValidationResult: Result of validating credentials.
        - `type` 'secret'
        - `status` 'success' | 'error', required
        - `msg` string
        - `detail` SecretValidationDetail: Detail of a secret validation result.
          - `environment` string, required
          - `secret_name` string, required
        - `ref` string, nullable
      - ExprValidationResult: Result of visiting an expression node.
        - `type` 'expression'
        - `status` 'success' | 'error', required
        - `msg` string
        - `detail` ValidationDetail[], nullable
          - `type` string, required
          - `msg` string, required
          - `loc` union[], nullable
            - union
              - …
        - `ref` string, nullable
        - `expression` string, nullable
        - `expression_type` 'generic' | 'action' | 'secret' | 'function' | 'input' | 'env' | 'local_vars' | 'literal' | 'typecast' | 'iterator' | 'ternary' | 'trigger' | 'template_action_step' | 'template_action_input' | 'variable', required
      - TemplateActionExprValidationResult: Result of visiting an expression node.
        - `type` 'action_template'
        - `status` 'success' | 'error', required
        - `msg` string
        - `detail` ValidationDetail[], nullable
          - `type` string, required
          - `msg` string, required
          - `loc` union[], nullable
            - union
              - …
        - `ref` string, nullable
        - `expression` string, nullable
        - `expression_type` 'generic' | 'action' | 'secret' | 'function' | 'input' | 'env' | 'local_vars' | 'literal' | 'typecast' | 'iterator' | 'ternary' | 'trigger' | 'template_action_step' | 'template_action_input' | 'variable', required
        - `loc` union[], required
          - union
            - string
            - integer
      - ActionValidationResult: Result of validating a registry action's arguments.
        - `type` 'action'
        - `status` 'success' | 'error', required
        - `msg` string
        - `detail` ValidationDetail[], nullable
          - `type` string, required
          - `msg` string, required
          - `loc` union[], nullable
            - union
              - …
        - `ref` string, nullable
        - `action_type` string, required
        - `validated_args` object, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/tracecat/apis/tracecat-api.md) - [All operations](https://skmtc.dev/tracecat/apis/tracecat-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tracecat/apis/tracecat-api/revisions/2efdda25045f?raw)
