nomad/website/source/api/validate.html.md

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
api	Validate - HTTP API	api-validate	The /validate endpoints are used to validate object structs, fields, and types.

Validate HTTP API

The /validate endpoints are used to validate object structs, fields, and types.

Validate Job

This endpoint validates a Nomad job file. The local Nomad agent forwards the request to a server. In the event a server can't be reached the agent verifies the job file locally but skips validating driver configurations.

~> This endpoint accepts a JSON job file, not an HCL job file.

Method	Path	Produces
POST	/v1/validate/job	application/json

The table below shows this endpoint's support for blocking queries, consistency modes, and required ACLs.

Blocking Queries	Consistency Modes	ACL Required
NO	none	none

Parameters

There are no parameters, but the request body contains the entire job file.

Sample Payload

(any valid nomad job IN JSON FORMAT)

Sample Request

$ curl \
    --request POST \
    --data @my-job.nomad \
    https://nomad.rocks/v1/validate/job

Sample Response

{
  "DriverConfigValidated": true,
  "ValidationErrors": [
    "Task group cache validation failed: 1 error(s) occurred:\n\n* Task redis validation failed: 1 error(s) occurred:\n\n* 1 error(s) occurred:\n\n* minimum CPU value is 20; got 1"
  ],
  "Error": "1 error(s) occurred:\n\n* Task group cache validation failed: 1 error(s) occurred:\n\n* Task redis validation failed: 1 error(s) occurred:\n\n* 1 error(s) occurred:\n\n* minimum CPU value is 20; got 1"
}