github.com/dkerwin/nomad@v0.3.3-0.20160525181927-74554135514b/website/source/docs/http/evals.html.md (about)

     1  ---
     2  layout: "http"
     3  page_title: "HTTP API: /v1/evaluations"
     4  sidebar_current: "docs-http-evals"
     5  description: |-
     6    The '/1/evaluations' endpoint is used to list the evaluations.
     7  ---
     8  
     9  # /v1/evaluations
    10  
    11  The `evaluations` endpoint is used to query the status of evaluations.
    12  By default, the agent's local region is used; another region can
    13  be specified using the `?region=` query parameter.
    14  
    15  ## GET
    16  
    17  <dl>
    18    <dt>Description</dt>
    19    <dd>
    20      Lists all the evaluations.
    21    </dd>
    22  
    23    <dt>Method</dt>
    24    <dd>GET</dd>
    25  
    26    <dt>URL</dt>
    27    <dd>`/v1/evaluations`</dd>
    28  
    29    <dt>Parameters</dt>
    30    <dd>
    31      <ul>
    32        <li>
    33          <span class="param">prefix</span>
    34          <span class="param-flags">optional</span>
    35          <span class="param-flags">even-length</span>
    36          Filter evaluations based on an identifier prefix.
    37        </li>
    38      </ul>
    39    </dd>
    40  
    41    <dt>Blocking Queries</dt>
    42    <dd>
    43      [Supported](/docs/http/index.html#blocking-queries)
    44    </dd>
    45  
    46    <dt>Returns</dt>
    47    <dd>
    48  
    49      ```javascript
    50      [
    51      {
    52          "ID": "151accaa-1ac6-90fe-d427-313e70ccbb88",
    53          "Priority": 50,
    54          "Type": "service",
    55          "TriggeredBy": "job-register",
    56          "JobID": "binstore-storagelocker",
    57          "JobModifyIndex": 14,
    58          "NodeID": "",
    59          "NodeModifyIndex": 0,
    60          "Status": "complete",
    61          "StatusDescription": "",
    62          "Wait": 0,
    63          "NextEval": "",
    64          "PreviousEval": "",
    65          "CreateIndex": 15,
    66          "ModifyIndex": 17
    67      },
    68      ...
    69      ]
    70      ```
    71  
    72    </dd>
    73  </dl>