listFiles

GET

/api/v1/agents/{agentId}/files

List a directory. Relative paths are relative to /home/agent. The agent must be running.

listFiles

curl --request GET \
  --url '<base-url>/api/v1/agents/<agentId>/files' \
  --cookie 'agenthold_session=<agenthold_session>'

const url = '<base-url>/api/v1/agents/<agentId>/files';
const options = {
  method: 'GET',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "path": "string",
  "entries": [
    {
      "name": "string",
      "size": 0,
      "mode": "string",
      "isDir": true,
      "isLink": true,
      "modTime": "2019-08-24T14:15:22Z"
    }
  ]
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Query parameters

path
optional
string

Returns

200

Directory listing.

JSON

path
string
required
Absolute path of the directory.
entries
array of
object
required
- name
  string
  required
- size
  integer
  required
  format: int64
- mode
  string
  required
- isDir
  boolean
  required
- isLink
  boolean
  required
- modTime
  string
  required
  format: date-time
}

400

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required

409

Error.

JSON

error
string
required