Skip to main content
Backendless logo
  • Category: developer tools
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 30
  • Triggers: 0
  • Slug: BACKENDLESS
  • Version: 20261101_00

Tools

Slug: BACKENDLESS_COPY_FILETool to copy a file or directory within Backendless file storage. Use when duplicating files to a new location after verifying source and destination paths.

Input Parameters

string
required
Absolute path of the file or directory to copy. Must start with a leading slash (’/’) and point to an existing resource.
string
required
Destination directory path where the source will be copied. Must start with a leading slash (’/’). Will be created if it does not exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_CREATE_DIRECTORYTool to create a new directory at the specified path. Use when you need to organize files under a new folder structure.

Input Parameters

string
Authorization token for secure file service. Required only if security is enabled.
string
required
Full path of the directory to create, without leading slash. Multi-level directories will be created automatically if they don’t exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_CREATE_HIVETool to create a new Hive. Use when you need to provision a new Hive resource before performing Hive operations. Example: Create a hive named ‘groceryStore’.

Input Parameters

string
required
Name of the hive to create. Must be URL-safe, without slashes. Allowed characters: letters, numbers, underscore, hyphen.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_CREATE_TIMERCreates a timer with a schedule for recurring or one-off server-side tasks.

Input Parameters

string
required
Unique name for the timer
integer
Expiration date/time in Unix epoch milliseconds. Timer will stop after this
object
required
Schedule and repeat configuration for the timer
integer
Start date/time in Unix epoch milliseconds. Defaults to now if omitted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_DELETE_DIRECTORYTool to delete a directory at the specified path in Backendless file storage. Use when you need to remove folders after confirming the path.

Input Parameters

string
Optional user authentication token. If provided, the delete operation will be executed under that user’s security policies.
string
required
Relative path of the directory to delete in file storage. Do not include a leading slash.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_DELETE_FILEDeletes a file from Backendless file storage at the specified path. Use this tool when you need to remove files from storage. The operation is permanent and cannot be undone. Ensure the file path is correct before deletion.

Input Parameters

string
Optional user-token obtained from login. When provided, the delete operation executes with the authenticated user’s permissions and security policies.
string
required
Path to the file in Backendless file storage. Can be provided with or without a leading slash. Examples: ‘txtfiles/test.txt’ or ‘/txtfiles/test.txt’ or ‘test.txt’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_DELETE_TIMERDeletes a Backendless timer by its unique name. Use this tool to permanently remove a scheduled timer from your Backendless application. The timer must exist and you must provide its exact name. Once deleted, the timer’s scheduled executions will stop immediately and cannot be recovered. Note: Requires access to Backendless Console Management API (available with Plus or Enterprise plans).

Input Parameters

string
required
Unique name of the timer to delete. Must match an existing timer name exactly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_DIRECTORY_LISTINGTool to retrieve a listing of files and directories at a given path. Use when browsing or filtering file storage directories.

Input Parameters

boolean
If true, list directories recursively.
string
required
Path of the directory to list. Must start with ’/’.
integer
Index of the first item to return for pagination.
string
Wildcard pattern to filter results; ’*’ matches any substring, ’?’ matches a single character.
integer
Maximum number of items to return.
string
User token for security policies. If provided, the request will be executed with user permissions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_GENERAL_OBJECT_RETRIEVALTool to retrieve objects from a specified Backendless table with filtering, sorting, and pagination. Use after confirming the table name and query options. Example: “Get Users where age > 30 sorted by created desc”.

Input Parameters

string
Comma-separated list of properties to include, e.g., ‘name,email’
string
SQL-like condition to filter objects, e.g., ‘age > 25’
string
Condition to filter groups after aggregation, e.g., ‘COUNT(*) > 1’
integer
Number of objects to skip before returning results. Default is 0 if not specified.
string
Comma-separated list of properties to sort by (append ‘desc’ for descending), e.g., ‘created desc’
string
Comma-separated list of properties to group by, e.g., ‘department’
string
Column name to return distinct values for, e.g., ‘city’
integer
Number of objects to return per page. Default is 10 if not specified.
string
required
Name of the data table to query, e.g., ‘Users’
string
User authentication token to apply user-level security policies
string
Comma-separated list of properties to exclude, e.g., ‘password’
string
Comma-separated list of related properties to include, e.g., ‘profile,address’
integer
Depth of related objects to include. Default is 1 if not specified.
integer
Number of related objects to return per page. Default is 10 if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_GET_ALL_VALUESRetrieve all values from a map in a specified Hive.

Input Parameters

string
required
Key name identifying the map.
string
required
Name of the Hive where the map is stored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_GET_COUNTER_VALUETool to retrieve the current value of a Backendless counter. Use when you need to inspect an atomic counter’s value.

Input Parameters

string
Optional user-token for enforcing user-level security policies.
string
required
Name of the counter to retrieve the value of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_GET_FILE_COUNTTool to get the count of files in a Backendless directory. Use when you need to determine how many items match a filter or include subdirectories.

Input Parameters

boolean
If true, include files in subdirectories recursively.
string
required
Path of the directory to count files in. Must start with ’/’.
string
Optional glob or regex pattern to filter files (prefix with ‘glob:’ or ‘regex:’).
string
Optional user-token header for authenticated operations. Enforces user security policies if provided.
boolean
If true, include directories in the count as well.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_GET_KEY_ITEMSTool to retrieve values for a specified key in a list (all, single, or range). Use when you need specific elements or the entire list from a Hive key. Supports single index retrieval, range retrieval, or full list.

Input Parameters

string
required
Key name identifying the list to retrieve.
integer
Zero-based index to retrieve a single element. Mutually exclusive with from_index and to_index.
integer
Zero-based end index for range retrieval. Must be provided together with from_index.
string
required
Name of the Hive where the list is stored.
integer
Zero-based start index for range retrieval. Must be provided together with to_index.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_GET_TIMERTool to retrieve information about a specific timer. Use when you need to inspect a timer’s schedule and next run details by name.

Input Parameters

string
required
Name of the timer to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_MAP_PUTTool to set or update key-value pairs in a Hive map. Use when you need to add or update multiple entries in a Hive map.

Input Parameters

object
required
Key-value pairs to set in the map.
string
required
Key name identifying the map.
string
required
Name of the Hive where the map is stored.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_MOVE_FILETool to move a file or directory within Backendless file storage. Use when relocating resources to a new path after verifying source and destination.

Input Parameters

string
required
Absolute path of the file or directory to move. Must start with a leading slash (’/’) and point to an existing resource.
string
required
Destination directory path where the source will be moved. Must start with a leading slash (’/’). Will be created if it does not exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_PUBLISH_MESSAGETool to publish a message to a specified messaging channel. Use when you need to send notifications or events to subscribers after confirming channel and payload.

Input Parameters

object
Additional message headers for delivery filtering.
string
required
Content of the message to publish; must be a valid JSON type.
integer
Unix timestamp in milliseconds when the message should be delivered.
string
Optional user token for security context; sent as ‘user-token’ header.
string
Unique identifier of the message publisher; optional.
integer
Frequency in seconds for repeating delivery.
string
required
Name of the channel to publish the message to.
integer
Unix timestamp in milliseconds when repeating should stop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_RESET_COUNTERTool to reset a Backendless counter back to zero. Use when you need to reinitialize a counter before starting a new sequence.

Input Parameters

string
Optional user-token for enforcing user-level security policies.
string
required
Name of the counter to reset to zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_SET_COUNTER_VALUETool to set a Backendless counter to a specific value conditionally. Use when you need to ensure the counter only updates if it currently matches an expected value.

Input Parameters

integer
required
The expected current value of the counter
string
Optional user-token for enforcing user-level security policies.
string
required
Name of the counter to update
integer
required
The new value to set if the current counter equals the expected value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_UPDATE_TIMERTool to update schedule or code of an existing timer. Use when you need to modify a timer’s configuration after retrieval.

Input Parameters

string
Updated code to execute when the timer runs
string
required
Name of the timer to update
integer
New expiration date/time in Unix epoch milliseconds
object
Updated schedule and repeat configuration for the timer
integer
New start date/time in Unix epoch milliseconds

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_USER_DELETETool to delete a user by user ID. Use when removing a user account after confirming permissions.

Input Parameters

string
required
The unique ID (objectId) of the user to delete.
string
Optional user authentication token. If provided, the operation uses the user’s security context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_USER_FINDTool to retrieve user information by ID. Use when you need to fetch details for a specific user after you have their objectId.

Input Parameters

string
required
The unique objectId of the user to retrieve.
string
Optional user authentication token. If provided, the request uses the user’s security context.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_USER_GRANT_PERMISSIONTool to grant a permission to a user on a specific data object. Use when precise access rights must be assigned after verifying the table and object IDs. Example: “Grant FIND permission to a user for a Person record”.

Input Parameters

string
required
Object ID of the user to whom the permission is being granted.
string
required
Unique identifier of the data object whose permissions are to be modified.
string ("UPDATE" | "FIND" | "REMOVE" | "DESCRIBE" | "PERMISSION" | "LOAD_RELATIONS" | "ADD_RELATION" | "DELETE_RELATION" | "UPSERT" | "*")
required
Type of permission to grant. Use ’*’ to grant all permissions.
string
required
Name of the data table containing the object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_USER_LOGINTool to log in a registered user with identity and password. Use when you need to authenticate a user before making subsequent requests. Example: “Login alice@wonderland.com with password wonderland”.

Input Parameters

string
required
Value for the property marked as identity (e.g., email).
string
required
User’s password (case-sensitive).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_USER_LOGOUTLogs out the user session identified by a supplied user token.

Input Parameters

string
required
Session token for the user. Use as ‘user-token’ header to authenticate the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_USER_PASSWORD_RECOVERYTool to initiate password recovery for a user. Use when a user requests a password reset after forgetting their password. Triggers an email with recovery instructions.

Input Parameters

string
required
Value of the property marked as identity on the Users table (by default this is an email). Must be URL-encoded in the request path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_USER_REGISTRATIONTool to register a new user with email and password. Use when creating a user account or converting a guest account to a registered one after collecting credentials. Example: Register ‘alice@wonderland.com’ with password ‘wonderland’.

Input Parameters

string
required
User’s email address used as identity in Backendless
string
Optional objectId of a guest user to convert into a registered user
string
required
Password for the new user (case-sensitive)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_USER_REVOKE_PERMISSIONTool to revoke a permission from a specified user or role on a specific data object. Use when you need to deny a previously granted operation for a user or role on a data object after verifying the table and object IDs.

Input Parameters

string
Name of the role to revoke the permission for. Ignored if ‘user’ is provided.
string
ObjectId of the user in the Users table. Provide this to revoke for a specific user.
string
required
Unique identifier of the data object whose permissions are to be modified
string ("UPDATE" | "FIND" | "REMOVE" | "DESCRIBE" | "PERMISSION" | "LOAD_RELATIONS" | "ADD_RELATION" | "DELETE_RELATION" | "UPSERT" | "*")
required
Type of permission to revoke. Use ’*’ to revoke all permissions.
string
required
Name of the data table containing the object

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_USER_UPDATETool to update properties of an existing Backendless user. Use when you need to modify user profile fields after login. Example: Update phoneNumber to “5551212”.

Input Parameters

string
required
ObjectId of the user to update
object
required
Key-value pairs of user properties to update
string
Session token obtained from a successful login. If provided, the update will be performed under that user’s owner policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BACKENDLESS_VALIDATE_USER_TOKENTool to validate a user session token. Use after obtaining a token from login to confirm the session is active.

Input Parameters

string
required
The session token to validate, returned by user login

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not