XPipe LogoXPipe Documentation

Read a remote file

Reads the entire content of a remote file through an active shell session.

POST
/fs/read

Authorization

bearerAuth
AuthorizationBearer <token>

The bearer token used is the session token that you receive from the handshake exchange.

In: header

Request Body

application/json

connection*string

The connection uuid

path*string

The target file path

Response Body

application/octet-stream

application/json

application/json

curl -X POST "http://localhost:21721/fs/read" \  -H "Content-Type: application/json" \  -d '{    "connection": "f0ec68aa-63f5-405c-b178-9a4454556d6b",    "path": "/home/user/myfile.txt"  }'
Empty
{
  "message": "string"
}
Empty
Empty
{
  "error": {
    "cause": {},
    "stackTrace": [],
    "suppressed": [],
    "localizedMessage": "string",
    "message": "string"
  }
}