---
title: "Schema"
html_title: "Enroll State Schema"
description: "JSON Schema describing the Enroll harvest state.json format."
layout: "schema"
---
<header class="py-5 hero">
  <div class="container py-3">
    <div class="kicker mb-3"><i class="bi bi-braces"></i> Schema</div>
    <h1 class="display-6 fw-bold mb-2">Harvest <code>state.json</code> schema</h1>
    <p class="lead mb-0"><code>enroll harvest</code> generates a state file. This is its structure.</p>
  </div>
</header>

<main class="py-5">
  <div class="container">
    <div class="row g-4">
      <div class="col-lg-4">
        <div class="callout p-4 mb-2">
          <div class="fw-semibold mb-2">Tips</div>
          <div class="d-grid gap-2">
	  <p class="secondary-text">You can validate a harvest against the schema by running <code>enroll validate /path/to/harvest</code> .</p>
          </div>
        </div>
        <div class="callout p-4">
          <div class="fw-semibold mb-2">Links</div>
          <div class="d-grid gap-2">
            <a class="btn btn-sm btn-outline-dark" href="schema/state.schema.json"><i class="bi bi-download"></i> Raw JSON Schema</a>
            <a class="btn btn-sm btn-outline-dark" href="docs.html#schema"><i class="bi bi-book"></i> Docs section</a>
          </div>
          <hr class="my-3">
        </div>
      </div>

      <div class="col-lg-8">
        <div class="feature-card p-4">
          <div class="d-flex align-items-center justify-content-between flex-wrap gap-2">
            <h2 class="h4 fw-bold mb-0">state.schema.json</h2>
            <a class="btn btn-sm btn-outline-secondary" href="schema/state.schema.json" target="_blank" rel="noreferrer"><i class="bi bi-box-arrow-up-right"></i> Open raw</a>
          </div>

          <div class="codeblock terminal mt-3">
            <button class="btn btn-sm btn-outline-secondary copy-btn" data-copy-target="#schema-code"><i class="bi bi-clipboard"></i> Copy</button>
            <pre class="mb-0"><code id="schema-code">Loading…</code></pre>
          </div>

	  <div class="small text-secondary mt-3">Tip: you can validate a harvest with <code>python -m jsonschema -i state.json schema/state.schema.json</code></div>
        </div>
      </div>
    </div>
  </div>
</main>