Every pipeline in Buddy has its own filesystem attached: a clone of the repository in the last built revision, the artifacts produced by the actions, and static files uploaded manually. Static files are the ones that should not live in the repository - environment configs or files with sensitive data - and they are preserved even when the pipeline cache is cleared.
The endpoints below manage those static files over the REST API, without opening the pipeline in the Buddy UI. Files are addressed by their path inside the pipeline filesystem, so the path you would use in an action command is the path you pass in the request URL.
Typical uses: seed a freshly created pipeline with the config files it needs, refresh a file that changed on your side, or read back the exact content the pipeline is currently running with.
Endpoints
| Endpoint | Description |
|---|---|
| Search files | Searches the pipeline filesystem with path and content filters and returns the matching files. |
| Add file | Adds a new file to the pipeline filesystem and marks it as a static file. |
| Get file | Returns the details and the content of a single file selected by its path. |
| Update file | Updates the content of an existing file and keeps it marked as a static file. |
| Delete file | Deletes a file from the pipeline filesystem by its path. |
Search files
Search files in the pipeline filesystem with path and content filters, and get back the list of matching files with their details.
Add file
Add a new file to the pipeline filesystem with a POST request. The file is stored as a static file and mounted for every action in the pipeline.
Get file
Fetch the details and the content of a single file from the pipeline filesystem by passing its path in the request URL.
Update file
Update the content of an existing file in the pipeline filesystem by its path. The file is saved as a static file of the pipeline.
Delete file
Delete a file from the pipeline filesystem by passing its path in the request URL, so it is no longer mounted for the pipeline actions.