XPipe LogoXPipe Documentation
HTTP API

Write blob to a remote file

Writes blob data to a file through an active shell session.

POST
/fs/write

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

blob*string

The blob uuid

path*string

The target filepath

Response Body

application/json

application/json

curl -X POST "http://localhost:21721/fs/write" \  -H "Content-Type: application/json" \  -d '{    "connection": "f0ec68aa-63f5-405c-b178-9a4454556d6b",    "blob": "854afc45-eadc-49a0-a45d-9fb76a484304",    "path": "/home/user/myfile.txt"  }'
Empty
{
  "message": "string"
}
Empty
Empty
{
  "error": {
    "cause": {},
    "stackTrace": [],
    "suppressed": [],
    "localizedMessage": "string",
    "message": "string"
  }
}
Edit on GitHub

Write blob to a shell script POST

Creates a shell script in the temporary directory of the file system that is access through the shell connection. This can be used to run more complex commands on remote systems.

Establish session POST

Prior to sending requests to the API, you first have to establish a new API session via the handshake endpoint. In the response you will receive a session token that you can use to authenticate during this session. This is done so that the daemon knows what kind of clients are connected and can manage individual capabilities for clients. If your client is running on the same system as the daemon, you can choose the local authentication method to avoid having to deal with API keys. If your client does not have file system access, e.g. if it is running remotely, then you have to use an API key. Note that for development you can also turn off the required authentication in the XPipe settings menu, allowing you to send unauthenticated requests. Certain connection IDs are hardcoded, e.g. the ID of the local machine connection. This makes it easier to perform actions on it across systems. The local machine connection ID is "f0ec68aa-63f5-405c-b178-9a4454556d6b". This one will be used in many of these samples.