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

     1  ---
     2  layout: "http"
     3  page_title: "HTTP API: /v1/client/fs/cat"
     4  sidebar_current: "docs-http-client-fs-cat"
     5  description: |-
     6    The '/1/client/fs/cat` endpoint is used to read the contents of a file in an
     7    allocation directory.
     8  ---
     9  
    10  # /v1/client/fs/cat
    11  
    12  The `/fs/cat` endpoint is used to read the contents of a file in an allocation
    13  directory. This API endpoint is hosted by the Nomad client and requests have to
    14  be made to the Nomad client where the particular allocation was placed.
    15  
    16  ## GET
    17  
    18  <dl>
    19    <dt>Description</dt>
    20    <dd>
    21       Read contents of 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/cat/<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 relative to the root of the allocation directory. It 
    37           defaults to `/`
    38        </li>
    39      </ul>
    40    </dd>
    41  
    42    <dt>Returns</dt>
    43    <dd>
    44  
    45      ```
    46      2016/03/15 15:40:56 [DEBUG] sylog-server: launching syslog server on addr:
    47      /tmp/plugin096499590
    48  
    49      ```
    50  
    51    </dd>
    52  
    53  </dl>