Backups API
All URIs are relative to http://localhost:1000
| Method | HTTP request | Description |
|---|---|---|
| backupsCreateNewBackup | POST /backups/create | /backups/create [POST] |
| backupsCreateNewBackupStreamed | POST /backups/create/streamed | /backups/create/streamed [POST] |
| backupsDeleteSpecificBackup | POST /backups/{backup}/delete | /backups/{backup}/delete [POST] |
| backupsSnapshot | GET /backups | /backups [GET] |
backupsCreateNewBackup​
Backup backupsCreateNewBackup()
This take a local database and ensure that it is backed up to the cloud.
Example​
import * as Pieces from '@pieces.app/pieces-os-client'
const configuration = Pieces.Configuration()
const apiInstance = new Pieces.BackupsApi(configuration)
const body: Pieces.BackupsCreateNewBackupRequest = {
// SeededBackup (optional)
seededBackup: ,
};
apiInstance.backupsCreateNewBackup(body).then((data: Backup) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))
Parameters​
| Name | Type | Description | Notes |
|---|---|---|---|
| seededBackup | SeededBackup |
Return type​
HTTP request headers​
- Content-Type: application/json
- Accept: application/json, text/plain
HTTP response details​
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
| 511 | Authentication Required, This means that you user needs to be authenticated with OS in order to perform this action | - |
| 505 | HTTP Version Not Supported, This means that your user needs to update their local os, or they cannot perform backup operations with the cloud | - |
backupsCreateNewBackupStreamed​
BackupStreamedProgress backupsCreateNewBackupStreamed()
This take a local database and ensure that it is backed up to the cloud. NOTE: This is a streamed version of the /backups/create. and Since the Generator is unable to generate a streamed endpoint. this is a place holder, and will need to be implemented isolated from the code generator.
Example​
import * as Pieces from '@pieces.app/pieces-os-client'
const configuration = Pieces.Configuration()
const apiInstance = new Pieces.BackupsApi(configuration)
const body: Pieces.BackupsCreateNewBackupStreamedRequest = {
// SeededBackup (optional)
seededBackup: ,
};
apiInstance.backupsCreateNewBackupStreamed(body).then((data: BackupStreamedProgress) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))
Parameters​
| Name | Type | Description | Notes |
|---|---|---|---|
| seededBackup | SeededBackup |
Return type​
HTTP request headers​
- Content-Type: application/json
- Accept: application/json, text/plain
HTTP response details​
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
| 511 | Authentication Required, This means that you user needs to be authenticated with OS in order to perform this action | - |
| 505 | HTTP Version Not Supported, This means that your user needs to update their local os, or they cannot perform backup operation with the cloud | - |
backupsDeleteSpecificBackup​
backupsDeleteSpecificBackup()
This will delete a specific backup from the cloud.
Example​
import * as Pieces from '@pieces.app/pieces-os-client'
const configuration = Pieces.Configuration()
const apiInstance = new Pieces.BackupsApi(configuration)
const body: Pieces.BackupsDeleteSpecificBackupRequest = {
// string | This is a identifier that is used to identify a specific backup.(version_timestamp)
backup: backup_example,
// Backup (optional)
backup2: ,
};
apiInstance.backupsDeleteSpecificBackup(body).then((data: void (empty response body)) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))
Parameters​
| Name | Type | Description | Notes |
|---|---|---|---|
| backup2 | Backup | ||
| backup | [string] | This is a identifier that is used to identify a specific backup.(version_timestamp) | defaults to undefined |
Return type​
void (empty response body)
HTTP request headers​
- Content-Type: application/json
- Accept: text/plain
HTTP response details​
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
| 500 | Internal Server Error | - |
| 511 | Authentication Required, This means that you user needs to be authenticated with OS in order to perform this action | - |
| 505 | HTTP Version Not Supported, This means that your user needs to update their local os, or they cannot perform backup operation with the cloud | - |
backupsSnapshot​
Backups backupsSnapshot()
This will get a snapshot of Backsup within the cloud. This endpoint requires our user to be authenticated and connected to the cloud.
Example​
import * as Pieces from '@pieces.app/pieces-os-client'
const configuration = Pieces.Configuration()
const apiInstance = new Pieces.BackupsApi(configuration)
apiInstance.backupsSnapshot().then((data: Backups) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))
Parameters​
This endpoint does not need any parameters.
Return type​
HTTP request headers​
- Content-Type: Not defined
- Accept: application/json, text/plain
HTTP response details​
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
| 511 | Authentication Required, This means that you user needs to be authenticated with OS in order to perform this action | - |
| 505 | HTTP Version Not Supported, This means that your user needs to update their local os, or they cannot perform backup operations with the cloud | - |