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

     1  ---
     2  layout: "http"
     3  page_title: "HTTP API: /v1/client/fs/stat"
     4  sidebar_current: "docs-http-client-fs-stat"
     5  description: |-
     6    The '/1/client/fs/stat` endpoint is used to stat a file in an allocation
     7    directory.
     8  ---
     9  
    10  # /v1/client/fs/stat
    11  
    12  The `/fs/stat` endpoint is used to stat a file in an allocation directory. This
    13  API endpoint is hosted by the Nomad client and requests have to be made to the
    14  Nomad client where the particular allocation was placed.
    15  
    16  ## GET
    17  
    18  <dl>
    19    <dt>Description</dt>
    20    <dd>
    21       Stat a file in an allocation directory.
    22    </dd>
    23  
    24    <dt>Method</dt>
    25    <dd>GET</dd>
    26  
    27    <dt>URL</dt>
    28    <dd>`/v1/client/fs/stat/<ALLOCATION-ID>`</dd>
    29  
    30    <dt>Parameters</dt>
    31    <dd>
    32      <ul>
    33        <li>
    34          <span class="param">path</span>
    35          <span class="param-flags">required</span>
    36          The path of the file relative to the root of the allocation directory.
    37        </li>
    38      </ul>
    39    </dd>
    40  
    41    <dt>Returns</dt>
    42    <dd>
    43  
    44      ```javascript
    45      {
    46        "Name": "redis-syslog-collector.out",
    47        "IsDir": false,
    48        "Size": 96,
    49        "FileMode": "-rw-rw-r--",
    50        "ModTime": "2016-03-15T15:40:56.822238153-07:00"
    51      }
    52      ```
    53  
    54    </dd>
    55  
    56  </dl>