Skip to content
Nexa Platform Docs

Validate Automation Artifacts

POST
/api/automations/{automation_alias}/validate-artifacts
curl --request POST \
  --url https://example.com/api/automations/example/validate-artifacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "attempt_id": "example" }'

Materialize automation.yaml + metadata.json + bundle in a temp dir, validate them, return file paths and design_content_hash. No git commit, no DB write. Web uses this for the “Generate Artifacts” step.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
automation_alias
required
Automation Alias
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AutomationCreateRequest
object
attempt_id
required
Attempt Id
string
Examplegenerated
{
  "attempt_id": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
AutomationValidateArtifactsResponse

Response for POST /automations/{alias}/validate-artifacts — validate-only.

Materializes metadata.json + automation.yaml + bundle files in a temp dir and returns whether they pass bundle validation. No git commit happens.

object
success
required
Success
boolean
attempt_id
required
Attempt Id
string
automation_alias
required
Automation Alias
string
validation_status
required
Validation Status
string
validation_errors
Validation Errors
Array<string>
files_to_commit
Files To Commit
Array<string>
design_content_hash
Any of:
string
metadata_preview
Any of:
object
key
additional properties
any
api_response_time_seconds
required
Api Response Time Seconds
number
Examplegenerated
{
  "success": true,
  "attempt_id": "example",
  "automation_alias": "example",
  "validation_status": "example",
  "validation_errors": [
    "example"
  ],
  "files_to_commit": [
    "example"
  ],
  "design_content_hash": "example",
  "metadata_preview": {},
  "api_response_time_seconds": 1
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}