Backendless
backendlessBackendless is a comprehensive backend-as-a-service (BaaS) platform providing scalable backend functionality for mobile and web applications, including user authentication, data persistence, file storage, and custom API services.
Acciones disponibles (31)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Copy FileBACKENDLESS_COPY_FILEAcciónTool to copy a file or directory within backendless file storage. use when duplicating files to a new location after verifying source and destination paths.
BACKENDLESS_COPY_FILEAcciónTool to copy a file or directory within backendless file storage. use when duplicating files to a new location after verifying source and destination paths.
Parámetros de entrada
source_pathstringObligatorioAbsolute path of the file or directory to copy. Must start with a leading slash ('/') and point to an existing resource.
target_pathstringObligatorioDestination directory path where the source will be copied. Must start with a leading slash ('/'). Will be created if it does not exist.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create DirectoryBACKENDLESS_CREATE_DIRECTORYAcciónTool to create a new directory at the specified path. use when you need to organize files under a new folder structure.
BACKENDLESS_CREATE_DIRECTORYAcciónTool to create a new directory at the specified path. use when you need to organize files under a new folder structure.
Parámetros de entrada
user_tokenstringAuthorization token for secure file service. Required only if security is enabled.
directory_pathstringObligatorioFull path of the directory to create, without leading slash. Multi-level directories will be created automatically if they don't exist.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Backendless HiveBACKENDLESS_CREATE_HIVEAcciónTool 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'.
BACKENDLESS_CREATE_HIVEAcciónTool 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'.
Parámetros de entrada
hive_namestringObligatorioName of the hive to create. Must be URL-safe, without slashes. Allowed characters: letters, numbers, underscore, hyphen.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Backendless TimerBACKENDLESS_CREATE_TIMERAcciónTool to create a new timer with schedule and code. use when scheduling recurring or one-off tasks to run server-side logic after confirming parameters.
BACKENDLESS_CREATE_TIMERAcciónTool to create a new timer with schedule and code. use when scheduling recurring or one-off tasks to run server-side logic after confirming parameters.
Parámetros de entrada
namestringObligatorioUnique name for the timer
expireintegerExpiration date/time in Unix epoch milliseconds. Timer will stop after this
frequencyobjectObligatorioSchedule and repeat configuration for the timer
startDateintegerStart date/time in Unix epoch milliseconds. Defaults to now if omitted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete DirectoryBACKENDLESS_DELETE_DIRECTORYAcciónTool to delete a directory at the specified path in backendless file storage. use when you need to remove folders after confirming the path.
BACKENDLESS_DELETE_DIRECTORYAcciónTool to delete a directory at the specified path in backendless file storage. use when you need to remove folders after confirming the path.
Parámetros de entrada
user_tokenstringOptional user authentication token. If provided, the delete operation will be executed under that user's security policies.
directory_pathstringObligatorioRelative path of the directory to delete in file storage. Do not include a leading slash.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete FileBACKENDLESS_DELETE_FILEAcciónTool to delete a file at the specified path in backendless file storage. use after confirming the file's relative path and filename.
BACKENDLESS_DELETE_FILEAcciónTool to delete a file at the specified path in backendless file storage. use after confirming the file's relative path and filename.
Parámetros de entrada
user_tokenstringOptional user-token from Backendless login. If provided, the delete operation runs with that user's security policy.
relative_pathstringObligatorioRelative path and filename in Backendless file storage to delete, without leading slash. Example: 'txtfiles/test.txt'.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Backendless TimerBACKENDLESS_DELETE_TIMERAcciónTool to delete a backendless timer by name. use when you need to remove a scheduled timer after confirming its name.
BACKENDLESS_DELETE_TIMERAcciónTool to delete a backendless timer by name. use when you need to remove a scheduled timer after confirming its name.
Parámetros de entrada
timer_namestringObligatorioName of the timer to delete
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Directory ListingBACKENDLESS_DIRECTORY_LISTINGAcciónTool to retrieve a listing of files and directories at a given path. use when browsing or filtering file storage directories.
BACKENDLESS_DIRECTORY_LISTINGAcciónTool to retrieve a listing of files and directories at a given path. use when browsing or filtering file storage directories.
Parámetros de entrada
subbooleanIf true, list directories recursively.
pathstringObligatorioPath of the directory to list. Must start with '/'.
offsetintegerIndex of the first item to return for pagination.
patternstringWildcard pattern to filter results; '*' matches any substring, '?' matches a single character.
pagesizeintegerMaximum number of items to return.
user_tokenstringUser token for security policies. If provided, the request will be executed with user permissions.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
General Object RetrievalBACKENDLESS_GENERAL_OBJECT_RETRIEVALAcciónTool 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".
BACKENDLESS_GENERAL_OBJECT_RETRIEVALAcciónTool 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".
Parámetros de entrada
propsstringComma-separated list of properties to include, e.g., 'name,email'
wherestringSQL-like condition to filter objects, e.g., 'age > 25'
havingstringCondition to filter groups after aggregation, e.g., 'COUNT(*) > 1'
offsetintegerNumber of objects to skip before returning results. Default is 0 if not specified.
sortBystringComma-separated list of properties to sort by (append 'desc' for descending), e.g., 'created desc'
groupBystringComma-separated list of properties to group by, e.g., 'department'
distinctstringColumn name to return distinct values for, e.g., 'city'
pageSizeintegerNumber of objects to return per page. Default is 10 if not specified.
table_namestringObligatorioName of the data table to query, e.g., 'Users'
user-tokenstringUser authentication token to apply user-level security policies
excludePropsstringComma-separated list of properties to exclude, e.g., 'password'
loadRelationsstringComma-separated list of related properties to include, e.g., 'profile,address'
relationsDepthintegerDepth of related objects to include. Default is 1 if not specified.
relationsPageSizeintegerNumber of related objects to return per page. Default is 10 if not specified.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All ValuesBACKENDLESS_GET_ALL_VALUESAcciónTool to retrieve all values from a map in a specified hive. use when you need to fetch the entire contents of a hive map at once.
BACKENDLESS_GET_ALL_VALUESAcciónTool to retrieve all values from a map in a specified hive. use when you need to fetch the entire contents of a hive map at once.
Parámetros de entrada
map_namestringObligatorioKey name identifying the map.
hive_namestringObligatorioName of the Hive where the map is stored.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Counter ValueBACKENDLESS_GET_COUNTER_VALUEAcciónTool to retrieve the current value of a backendless counter. use when you need to inspect an atomic counter's value.
BACKENDLESS_GET_COUNTER_VALUEAcciónTool to retrieve the current value of a backendless counter. use when you need to inspect an atomic counter's value.
Parámetros de entrada
user_tokenstringOptional user-token for enforcing user-level security policies.
counter_namestringObligatorioName of the counter to retrieve the value of.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get File CountBACKENDLESS_GET_FILE_COUNTAcciónTool 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.
BACKENDLESS_GET_FILE_COUNTAcciónTool 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.
Parámetros de entrada
subbooleanIf true, include files in subdirectories recursively.
pathstringObligatorioPath of the directory to count files in. Must start with '/'.
patternstringOptional glob or regex pattern to filter files (prefix with 'glob:' or 'regex:').
user_tokenstringOptional user-token header for authenticated operations. Enforces user security policies if provided.
count_directoriesbooleanIf true, include directories in the count as well.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Key ItemsBACKENDLESS_GET_KEY_ITEMSAcciónTool 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.
BACKENDLESS_GET_KEY_ITEMSAcciónTool 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.
Parámetros de entrada
keystringObligatorioKey name identifying the list to retrieve.
indexintegerZero-based index to retrieve a single element. Mutually exclusive with from_index and to_index.
to_indexintegerZero-based end index for range retrieval. Must be provided together with from_index.
hive_namestringObligatorioName of the Hive where the list is stored.
from_indexintegerZero-based start index for range retrieval. Must be provided together with to_index.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Backendless TimerBACKENDLESS_GET_TIMERAcciónTool to retrieve information about a specific timer. use when you need to inspect a timer's schedule and next run details by name.
BACKENDLESS_GET_TIMERAcciónTool to retrieve information about a specific timer. use when you need to inspect a timer's schedule and next run details by name.
Parámetros de entrada
namestringObligatorioName of the timer to retrieve
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Map PutBACKENDLESS_MAP_PUTAcciónTool 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.
BACKENDLESS_MAP_PUTAcciónTool 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.
Parámetros de entrada
entriesobjectObligatorioKey-value pairs to set in the map.
map_namestringObligatorioKey name identifying the map.
hive_namestringObligatorioName of the Hive where the map is stored.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Move FileBACKENDLESS_MOVE_FILEAcciónTool to move a file or directory within backendless file storage. use when relocating resources to a new path after verifying source and destination.
BACKENDLESS_MOVE_FILEAcciónTool to move a file or directory within backendless file storage. use when relocating resources to a new path after verifying source and destination.
Parámetros de entrada
source_pathstringObligatorioAbsolute path of the file or directory to move. Must start with a leading slash ('/') and point to an existing resource.
target_pathstringObligatorioDestination directory path where the source will be moved. Must start with a leading slash ('/'). Will be created if it does not exist.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Publish MessageBACKENDLESS_PUBLISH_MESSAGEAcciónTool 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.
BACKENDLESS_PUBLISH_MESSAGEAcciónTool 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.
Parámetros de entrada
headersobjectAdditional message headers for delivery filtering.
messagestringObligatorioContent of the message to publish; must be a valid JSON type.
publishAtintegerUnix timestamp in milliseconds when the message should be delivered.
user_tokenstringOptional user token for security context; sent as 'user-token' header.
publisherIdstringUnique identifier of the message publisher; optional.
repeatEveryintegerFrequency in seconds for repeating delivery.
channel_namestringObligatorioName of the channel to publish the message to.
repeatExpiresAtintegerUnix timestamp in milliseconds when repeating should stop.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reset CounterBACKENDLESS_RESET_COUNTERAcciónTool to reset a backendless counter back to zero. use when you need to reinitialize a counter before starting a new sequence.
BACKENDLESS_RESET_COUNTERAcciónTool to reset a backendless counter back to zero. use when you need to reinitialize a counter before starting a new sequence.
Parámetros de entrada
user_tokenstringOptional user-token for enforcing user-level security policies.
counter_namestringObligatorioName of the counter to reset to zero.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Counter ValueBACKENDLESS_SET_COUNTER_VALUEAcciónTool 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.
BACKENDLESS_SET_COUNTER_VALUEAcciónTool 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.
Parámetros de entrada
expectedintegerObligatorioThe expected current value of the counter
user_tokenstringOptional user-token for enforcing user-level security policies.
counter_namestringObligatorioName of the counter to update
updatedvalueintegerObligatorioThe new value to set if the current counter equals the expected value
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update Backendless TimerBACKENDLESS_UPDATE_TIMERAcciónTool to update schedule or code of an existing timer. use when you need to modify a timer's configuration after retrieval.
BACKENDLESS_UPDATE_TIMERAcciónTool to update schedule or code of an existing timer. use when you need to modify a timer's configuration after retrieval.
Parámetros de entrada
codestringUpdated code to execute when the timer runs
namestringObligatorioName of the timer to update
expireintegerNew expiration date/time in Unix epoch milliseconds
frequencyobjectUpdated schedule and repeat configuration for the timer
startDateintegerNew start date/time in Unix epoch milliseconds
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Change User PasswordBACKENDLESS_USER_CHANGE_PASSWORDAcciónTool to change the password for the current user. use when you need to securely update a user's password after login. example prompt: "change my password to n3wp@ssw0rd!".
BACKENDLESS_USER_CHANGE_PASSWORDAcciónTool to change the password for the current user. use when you need to securely update a user's password after login. example prompt: "change my password to n3wp@ssw0rd!".
Parámetros de entrada
user_idstringObligatorioObjectId of the user whose password will be updated.
passwordstringObligatorioThe new password to set for the user. Must comply with password policy.
user_tokenstringObligatorioSession token obtained from a successful login.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete UserBACKENDLESS_USER_DELETEAcciónTool to delete a user by user id. use when removing a user account after confirming permissions.
BACKENDLESS_USER_DELETEAcciónTool to delete a user by user id. use when removing a user account after confirming permissions.
Parámetros de entrada
user_idstringObligatorioThe unique ID (objectId) of the user to delete.
user_tokenstringOptional user authentication token. If provided, the operation uses the user's security context.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Find User by IDBACKENDLESS_USER_FINDAcciónTool to retrieve user information by id. use when you need to fetch details for a specific user after you have their objectid.
BACKENDLESS_USER_FINDAcciónTool to retrieve user information by id. use when you need to fetch details for a specific user after you have their objectid.
Parámetros de entrada
user_idstringObligatorioThe unique objectId of the user to retrieve.
user_tokenstringOptional user authentication token. If provided, the request uses the user's security context.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Grant Permission to UserBACKENDLESS_USER_GRANT_PERMISSIONAcciónTool 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".
BACKENDLESS_USER_GRANT_PERMISSIONAcciónTool 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".
Parámetros de entrada
userstringObligatorioObject ID of the user to whom the permission is being granted.
object_idstringObligatorioUnique identifier of the data object whose permissions are to be modified.
permissionstringObligatorioenumType of permission to grant. Use '*' to grant all permissions.
UPDATEFINDREMOVEDESCRIBEPERMISSIONLOAD_RELATIONSADD_RELATIONDELETE_RELATIONUPSERT*table_namestringObligatorioName of the data table containing the object.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
User LoginBACKENDLESS_USER_LOGINAcciónTool 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".
BACKENDLESS_USER_LOGINAcciónTool 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".
Parámetros de entrada
loginstringObligatorioValue for the property marked as identity (e.g., email).
passwordstringObligatorioUser's password (case-sensitive).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
User LogoutBACKENDLESS_USER_LOGOUTAcciónTool to log out the currently authenticated user. use when you need to terminate the user session after operations.
BACKENDLESS_USER_LOGOUTAcciónTool to log out the currently authenticated user. use when you need to terminate the user session after operations.
Parámetros de entrada
user-tokenstringObligatorioSession token for the user. Use as 'user-token' header to authenticate the request.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
User Password RecoveryBACKENDLESS_USER_PASSWORD_RECOVERYAcciónTool 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.
BACKENDLESS_USER_PASSWORD_RECOVERYAcciónTool 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.
Parámetros de entrada
user_identitystringObligatorioValue of the property marked as identity on the Users table (by default this is an email). Must be URL-encoded in the request path.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
User RegistrationBACKENDLESS_USER_REGISTRATIONAcciónTool 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'.
BACKENDLESS_USER_REGISTRATIONAcciónTool 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'.
Parámetros de entrada
emailstringObligatorioUser's email address used as identity in Backendless
objectIdstringOptional objectId of a guest user to convert into a registered user
passwordstringObligatorioPassword for the new user (case-sensitive)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Revoke Permission from UserBACKENDLESS_USER_REVOKE_PERMISSIONAcciónTool to revoke a permission from a specified user or role on a data table. use when you need to deny a previously granted data-table operation for a user or role in cloudcode after confirming the target.
BACKENDLESS_USER_REVOKE_PERMISSIONAcciónTool to revoke a permission from a specified user or role on a data table. use when you need to deny a previously granted data-table operation for a user or role in cloudcode after confirming the target.
Parámetros de entrada
rolestringName of the role to revoke the permission for. Ignored if 'user' is provided.
userstringObjectId of the user in the Users table. Provide this to revoke for a specific user.
permissionstringObligatorioenumPermission to revoke. One of 'ADD', 'UPDATE', 'FIND', 'REMOVE', 'DESCRIBE', 'PERMISSION', 'LOAD_RELATIONS', 'ADD_RELATION', 'DELETE_RELATION', 'UPSERT', or '*' (all permissions).
ADDUPDATEFINDREMOVEDESCRIBEPERMISSIONLOAD_RELATIONSADD_RELATIONDELETE_RELATIONUPSERT*table_namestringObligatorioName of the data table to revoke the permission from, e.g., 'Person'
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update UserBACKENDLESS_USER_UPDATEAcciónTool to update properties of an existing backendless user. use when you need to modify user profile fields after login. example: update phonenumber to "5551212".
BACKENDLESS_USER_UPDATEAcciónTool to update properties of an existing backendless user. use when you need to modify user profile fields after login. example: update phonenumber to "5551212".
Parámetros de entrada
user_idstringObligatorioObjectId of the user to update
propertiesobjectObligatorioKey-value pairs of user properties to update
user_tokenstringSession token obtained from a successful login. If provided, the update will be performed under that user's owner policy.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Validate User TokenBACKENDLESS_VALIDATE_USER_TOKENAcciónTool to validate a user session token. use after obtaining a token from login to confirm the session is active.
BACKENDLESS_VALIDATE_USER_TOKENAcciónTool to validate a user session token. use after obtaining a token from login to confirm the session is active.
Parámetros de entrada
userTokenstringObligatorioThe session token to validate, returned by user login
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not