### GET /api/v1/backup/settings Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index Fetches settings saved to your BlueBubbles Server. Optionally, settings can be filtered by name. ```APIDOC ## GET /api/v1/backup/settings ### Description Fetches settings saved to your BlueBubbles Server. Optionally, settings can be filtered by name. ### Method GET ### Endpoint {{host}}/api/v1/backup/settings?password={{password}}&name= ### Parameters #### Query Parameters - **password** (string) - Required - Your BlueBubbles Server password - **name** (string) - Optional - Find a settings configuration by name. If no match is found, null is returned. ### Request Example ```curl curl --location -g '{{host}}/api/v1/backup/settings?password={{password}}&name=' ``` ### Response #### Success Response (200) No response body ``` -------------------------------- ### POST /api/v1/backup/settings Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index Saves a settings configuration to your BlueBubbles Server App. Requires 'name' and 'data' fields in the request body. ```APIDOC ## POST /api/v1/backup/settings ### Description Save a Settings configuration to your BlueBubbles Server App. This request has 2 required fields, `name` and `data`. Otherwise, the actual configuration data is up to the client. The only caveat is that clients that are pulling settings from the server need to be able to understand the format. ### Method POST ### Endpoint {{host}}/api/v1/backup/settings?password={{password}} ### Parameters #### Query Parameters - **password** (string) - Required - Your BlueBubbles Server password #### Request Body - **name** (string) - Required - The name of your settings backup. - **data** (object) - Required - The configuration data for your settings. ### Request Example ```curl curl --location -g '{{host}}/api/v1/backup/settings?password={{password}}' \ --data '{ "name": "SettingsBackup - 2021/10/11", "data": {} }' ``` ### Response #### Success Response (200) No response body ``` -------------------------------- ### Create Settings Backup (JSON) Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index This snippet shows the JSON structure for creating a settings backup. It requires a 'name' field to identify the backup. This is typically sent as the request body in a POST request. ```json { "name": "SettingsBackup - 2021/10/11" } ``` -------------------------------- ### Fetch Settings Backup (cURL) Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index This cURL command fetches settings backups from the BlueBubbles Server. It requires the server password and optionally accepts a 'name' parameter to filter settings by name. If no name is provided, it may return all settings or a default. ```cURL curl --location -g '{{host}}/api/v1/backup/settings?password={{password}}&name=' ``` -------------------------------- ### Save Settings Backup (cURL) Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index This cURL command saves settings configurations to the BlueBubbles Server. It requires the server password, a 'name' for the settings, and 'data' representing the configuration. The data format is client-defined but must be understandable by clients retrieving the settings. ```cURL curl --location -g '{{host}}/api/v1/backup/settings?password={{password}}' \ --data '{ "name": "SettingsBackup - 2021/10/11", "data": {} }' ``` -------------------------------- ### DELETE /api/v1/backup/settings Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index Deletes backup settings based on the provided name and password. ```APIDOC ## DELETE /api/v1/backup/settings ### Description Deletes backup settings using the provided name and password. ### Method DELETE ### Endpoint /api/v1/backup/settings ### Parameters #### Query Parameters - **password** (string) - Required - Your BlueBubbles Server password #### Request Body - **name** (string) - Required - The name of your settings to delete ### Request Example ```json { "name": "SettingsBackup - 2021/10/11" } ``` ### Response #### Success Response (200) This request doesn't return any response body. #### Response Example No response body ``` -------------------------------- ### DELETE /api/v1/backup/theme Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index Deletes a theme backup by its name from the BlueBubbles Server. ```APIDOC ## DELETE /api/v1/backup/theme ### Description Deletes a theme backup by name. ### Method DELETE ### Endpoint {{host}}/api/v1/backup/theme?password={{password}} ### Parameters #### Query Parameters - **password** (string) - Required - Your BlueBubbles Server password #### Request Body - **name** (string) - Required - The name of the theme backup to delete. ### Request Example ```curl curl --location -g --request DELETE '{{host}}/api/v1/backup/theme?password={{password}}' \ --data '{ "name": "ThemeBackup - 2021/10/11" }' ``` ### Response #### Success Response (200) No response body ``` -------------------------------- ### DELETE /api/v1/backup/settings Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index Deletes a settings backup by its name from the BlueBubbles Server. ```APIDOC ## DELETE /api/v1/backup/settings ### Description Deletes a settings backup by name. ### Method DELETE ### Endpoint {{host}}/api/v1/backup/settings?password={{password}} ### Parameters #### Query Parameters - **password** (string) - Required - Your BlueBubbles Server password ### Response #### Success Response (200) No response body ``` -------------------------------- ### Delete Settings Backup (cURL) Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index This cURL command demonstrates how to delete a settings backup from the BlueBubbles server. It requires the server host, the user's password, and the name of the backup to be deleted, sent as form data. ```curl curl --location -g --request DELETE '{{host}}/api/v1/backup/settings?password={{password}}' \ --data '{ "name": "SettingsBackup - 2021/10/11" }' ``` -------------------------------- ### Delete Theme Backup by Name (cURL) Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index This cURL command deletes a theme backup from the BlueBubbles Server. It requires the server password and the name of the theme to be deleted, sent in the request body as JSON. The request method is DELETE. ```cURL curl --location -g --request DELETE '{{host}}/api/v1/backup/theme?password={{password}}' \ --data '{ "name": "ThemeBackup - 2021/10/11" }' ``` -------------------------------- ### Delete Settings Backup by Name (cURL) Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index This cURL command deletes a settings backup by its name from the BlueBubbles Server. It requires the server password and the name of the settings backup to be deleted. The request method is DELETE. ```cURL curl --location -g --request DELETE '{{host}}/api/v1/backup/settings?password={{password}}' ``` -------------------------------- ### Lock macOS Device via API (cURL) Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index This cURL command locks the macOS device. It requires the BlueBubbles Server password as a query parameter. This endpoint is useful for security purposes to prevent unauthorized access if the device is compromised. ```cURL curl --location -g --request POST '{{scheme}}://{{host}}:1234/api/v1/mac/lock?password={{password}}' ``` -------------------------------- ### POST /api/v1/mac/lock Source: https://documenter.getpostman.com/view/765844/UV5RnfwM/index Locks the macOS device directly via the API. This endpoint is useful for securing the device if it's believed to be compromised. It locks the account but does not log the user out. ```APIDOC ## POST /api/v1/mac/lock ### Description Locks the macOS device directly via the API. This endpoint can be useful if you believe your macOS device has been compromised. Locking it will prevent the adversary from accessing your account. This will not log you out, but will lock your account. ### Method POST ### Endpoint {{host}}/api/v1/mac/lock?password={{password}} ### Parameters #### Query Parameters - **password** (string) - Required - Your BlueBubbles Server password ### Request Example ```curl curl --location -g --request POST '{{scheme}}://{{host}}:1234/api/v1/mac/lock?password={{password}}' ``` ### Response #### Success Response (200) - **status** (integer) - The status code of the response. - **message** (string) - A message indicating the success of the operation. - **data** (string) - A confirmation message. #### Response Example ```json { "status": 200, "message": "Success", "data": "Successfully executed lock command!" } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.