Skip to content
Changelog

Report a bug

Backendless integration: operations for AI agents

Backendless connects to Type.com as an integration. This page lists the 129 operations documented for Claude and Codex in Type.com: 45 read, 58 write, 26 destructive.

About Backendless

Backendless 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.

Categories: Developer Tools & IT

How to connect Backendless to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

129 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

129 operations listed.

  • Read

    Data Retrieval with Grouping

    Backendless offers a robust feature set for managing and querying your database, including the ability to retrieve data in grouped formats. While Aggregate Functions in Backendless provide a powerful API for summarizing and calculating data across groups, this chapter delves into a distinct and equally important capability: Grouped Data Retrieval.

    POST /api/data/data-grouping/{tableOrViewName}

  • Read

    Two Steps Retrieval

    Two Step Retrieval loads only a partial set of the related objects (default size of the retrieved related collection is 10). To load additional related objects, use the Relation Paging API .

    POST /api/data/{TABLE_NAME}/{OBJECT_ID}/{relatedPropertyName}/load

  • Read

    Basic Object Retrieval

    Backendless supports multiple data search and retrieval operations. These include finding an object by its objectId , finding first or last object in the collection or retrieving the entire persisted collection.

    GET /api/data/{table_name}

  • Read

    Basic Object Retrieval

    Backendless supports multiple data search and retrieval operations. These include finding an object by its objectId , finding first or last object in the collection or retrieving the entire persisted collection.

    GET /api/data/{table_name}/first

  • Read

    Basic Object Retrieval

    Backendless supports multiple data search and retrieval operations. These include finding an object by its objectId , finding first or last object in the collection or retrieving the entire persisted collection.

    GET /api/data/{table_name}/last

  • Read

    Find User By

    This operation finds a specific user by objectId or by identity in the Users data table. The search by identity is only available in Codeless . Alternative documented variant: Backendless supports multiple data search and retrieval operations. These include finding an object by its objectId , finding first or last object in the collection or retrieving the entire persisted collection.

    GET /api/data/{table_name}/{objectId}

  • Read

    Directory Listing

    A collection of files and directories matching the specified pattern. The returned collection may not include all files and directories as the size of the number of returned entries is limited for paging purposes. To get the next set of file/directory entries, an additional request must be made with a different offset value. The total count of all files/directories in the listing use the Get File Count API . Alternative documented variant: This operation returns the number of files and optionally directories located in the specified path. Additional options include:

    GET /api/files/{path}

  • Read

    Get Hive Names

    Make sure to replace xxxx in the domain name in the request specification below to the one assigned to your application.

    GET /api/hive

  • Read

    Get Values

    This operation returns multiple key-value pairs for the specified key names.

    POST /api/hive/{hive_name}/key-value

  • Read

    Get Value

    This operation retrieves a value associated with the specified key.

    GET /api/hive/{hive_name}/key-value/{key}

  • Read

    Get Key Items

    This operation returns the values for the specified keys. It has variations where it can return a single value for a key or a range of values based on indexes.

    GET /api/hive/{hive_name}/list/{key}

  • Read

    Length

    This operation counts and returns the number of values in the list.

    GET /api/hive/{hive_name}/list/{key}/length

  • Read

    Get Key Items

    This operation returns the values for the specified keys. It has variations where it can return a single value for a key or a range of values based on indexes.

    GET /api/hive/{hive_name}/list/{key}/{index}

  • Read

    Get All Values

    This operation retrieves all values from a map.

    GET /api/hive/{hive_name}/map/values

  • Read

    Get All Key-Values

    This operation returns all key-value pairs from a map.

    GET /api/hive/{hive_name}/map/{key}

  • Read

    Get Specific Key-Values

    This operation retrieves specific key-value pairs from a map.

    POST /api/hive/{hive_name}/map/{key}

  • Read

    Check If Exists

    This operation verifies if a specific key exists in the specified map.

    GET /api/hive/{hive_name}/map/{key}/exists/{key_name}

  • Read

    Get Value By Key Name

    This operation returns a value associated with a key.

    GET /api/hive/{hive_name}/map/{key}/get/{key_name}

  • Read

    Get All Keys Names

    This operation returns all key names from a map.

    GET /api/hive/{hive_name}/map/{key}/keys

  • Read

    Length

    This operation counts the number of elements in the map and returns the total.

    GET /api/hive/{hive_name}/map/{key}/length

  • Read

    Get Key Items

    This operation returns all values from the specified set.

    GET /api/hive/{hive_name}/set/{key}

  • Read

    Contains

    This operation checks if specific values exist in a set.

    POST /api/hive/{hive_name}/set/{key}/contains

  • Read

    Length

    This operation counts the number of elements in the set and returns the total.

    GET /api/hive/{hive_name}/set/{key}/length

  • Read

    Get Random Values

    This operation returns the specified number of random values from a set.

    GET /api/hive/{hive_name}/set/{key}/random

  • Read

    Length with a Query

    This operation returns the number of items with a score a range between the specified min and max values.

    GET /api/hive/{hive_name}/sorted-set/{key}/count

  • Read

    Get Values By Rank Range

    This operation returns values for a range of rank numbers. A rank in a sorted set determines the position of an element. For more information about the rank, refer to the Hive Overview section of this guide.

    GET /api/hive/{hive_name}/sorted-set/{key}/get-range-by-rank

  • Read

    Get Values By Score Range

    This operation returns values for a range of scores.

    GET /api/hive/{hive_name}/sorted-set/{key}/get-range-by-score

  • Read

    Get Rank

    This operation returns the rank of a specific item from the sorted set. Rank in a sorted set determines the position of an element. For more information about the rank, refer to the Hive Overview section of this guide.

    POST /api/hive/{hive_name}/sorted-set/{key}/get-rank

  • Read

    Get Score

    This operation returns the score of a value from a sorted set.

    POST /api/hive/{hive_name}/sorted-set/{key}/get-score

  • Read

    Length

    This operation returns the number of items in the sorted set.

    GET /api/hive/{hive_name}/sorted-set/{key}/length

  • Read

    Check If Keys Exist

    This operation checks if specific keys exist in the specified store.

    POST /api/hive/{hive_name}/{bucket_type}/action/exist

  • Read

    Get Key Names

    This operation retrieves key names from a specific store type. Key names are retrieved with paging, the default page size is 10,000 items. The operation supports filtering, where the returned key names match the specified pattern.

    GET /api/hive/{hive_name}/{bucket_type}/keys

  • Read

    Get Key Expiration Time

    This operation retrieves the expiration time for a key. The expiration time is expressed as a number of seconds until the key expires. Note that all keys are created without timeouts by default, and you can set it by invoking the "Set Key Expiration - TTL" or the "Set Key Expiration - Unix time" operations.

    GET /api/hive/{hive_name}/{bucket_type}/{key}/get-expiration-ttl

  • Read

    Time Since Last Operation

    The Hive system maintains a timer for every key that measures the number of seconds elapsed since the last operation. This operation returns the time calculated by the timer as a number of seconds elapsed since the last operation performed on the specified key.

    GET /api/hive/{hive_name}/{bucket_type}/{key}/seconds-since-last-operation

  • Read

    Retrieve Device Registration

    Backendless server returns information about device registration with the API documented below. The input parameter of the API is deviceId - the value returned by the device registration API .

    GET /api/messaging/registrations/{device_id}

  • Read

    Retrieve Messages

    The API returns messages for a subscription. To establish a subscription use the Channel Subscription API . If the subscription includes a selector ( conditional delivery ), only the messages which match the selector will be returned in the response. Otherwise, the response includes all messages received in the past 60 seconds. The expiration timeframe for the messages can be modified in the Backendless Pro version of the product. Messages previously returned to the client are excluded for the subsequent requests.

    GET /api/messaging/{channel_name}/{subscription_id}

  • Read

    Get Message Status

    Backendless server handles message publishing as an autonomous task. As a result, the final status of the message publishing operation is not available right away. To retrieve the status, the client application must make a separate API call as documented below: Alternative documented variant: Backendless processes push notification delivery asynchronously. Even when the client app uses blocking/synchronous API, the server creates a push notification delivery task and adds to a queue. Server assigns an ID to the task and returns it to the client as messageId . As a result, push notification delivery status is not available right away. To retrieve the status, the client application must make a separate API call documented below:

    GET /api/messaging/{message_id}

  • Read

    Validating User Login

    The user-token value can be saved in the client application so it can be used when the application is restarted. This helps in streamlining the user experience since the user of the application does not need to login again. However, when the application restarts, it needs to check if the underlying user token, and hence the user session is still valid. This can be accomplished with the API below:

    GET /api/users/isvalidusertoken/{userToken}

  • Read

    Retrieving Users By Role

    All users have different roles assigned to them, those can be default system roles assigned by the system and also custom roles . By invoking this operation you can find users by a custom role; the result of this operation is an array of user objects found by a specific role. This operation works only with custom roles, otherwise an error message will be returned in response.

    GET /api/users/role/{roleName}

  • Read

    Retrieve User Schema

    This operation retrieves a list of the properties associated with the user schema.

    GET /api/users/userclassprops

  • Read

    Retrieving Available User Roles

    This operation returns a list of the roles associated with the user account currently logged in to the Backendless application. If the request is sent without logging in, the system will return only one role - NotAuthenticatedUser .

    GET /api/users/userroles

  • Read

    Retrieving User Properties

    This operation allows retrieving user properties from the user object stored locally in the client application.

    GET /api/users/{user_objectId}

  • Read

    Validating In-App Purchase

    The App Store and Google Play services provide a mechanism that allows validating the authenticity of an in-app purchase. It is used as a protection measure against fraudulent transactions. The receipt(iOS)/token(Android) becomes available in the app after the first in-app purchase, and depending on the platform can be validated using the API described below.

    GET /commerce/googleplay/validate/{packageName}/inapp/{productId}/purchases/{token}

  • Read

    Managing Subscriptions

    Backendless provides two APIs for Android platform that allow retrieving the current subscription status of an application, and also cancelling an active subscription.

    GET /commerce/googleplay/{packageName}/subscription/{subscriptionId}/purchases/{token}

  • Read

    Retrieving User Roles By User ID

    This operation can be used to retrieve custom and system roles assigned to a user.

    GET /{application_id}/{CLOUDCODE_api_key}/users/userroles/{userId}

  • Write

    Saving Multiple Objects

    This API stores multiple objects in a data table with a single request. Consider the following example, it demonstrates an API call which saves two objects in the Person data table:

    POST /api/data/bulk/{table_name}

  • Write

    Updating Multiple Objects

    This API updates multiple objects in a data table with a single request. Consider the following example, it demonstrates an API call which updates all objects in the Person data table where the value of the property age is greater than 20 . As a result of the request, all updated objects will have the contactType property set to "personal" :

    PUT /api/data/bulk/{table_name}

  • Write

    Upsert Multiple Objects

    This operation creates and/or updates multiple objects in the database. The operation receives a collection of objects as the argument. For every object in the collection it checks if an object already exists in the database and in that case updates it with the property values in the object. Otherwise, the object is saved in the database. To check if an object exists in the database, Backendless uses the value of the objectId property.

    PUT /api/data/bulkupsert/{table_name}

  • Write

    Saving Single Object

    A JSON object to save in the database. Object properties must match the names of the table columns. The object must not have the objectId property.

    POST /api/data/{table_name}

  • Write

    Overview

    The "Deep Save" functionality is a single API request that can create or update a complete "object tree" in the database using a single transaction. The object tree starts with the root object and includes other child objects, their corresponding children and so on. Consider the following object diagram:

    PUT /api/data/{table_name}/deep-save

  • Write

    Upsert Single Object

    With this operation, you can either update an existing object or insert a new one into the database. To update an existing object, the operation locates it using its objectId value. If the object cannot be found, the operation inserts a new object into the data table with the specified objectId value.

    PUT /api/data/{table_name}/upsert

  • Write

    Updating Single Object

    A JSON object to update in the database. The object may reference only the properties to update, but it is acceptable to include all properties of the object (including the ones to update). In this case, Backendless will update the entire object.

    PUT /api/data/{table_name}/{objectId}

  • Write

    Save Files From Byte Arrays

    In addition to the classic file upload , files can be saved by uploading a byte array which becomes the content of the saved file.

    PUT /api/files/binary/{filePath}

  • Write

    Copying a File/Directory

    Copy the file or directory identified by sourcePath into targetPath; create the target directory if it does not exist.

    PUT /api/files/copy

  • Write

    Moving a File/Directory

    Move the file or directory identified by sourcePath into targetPath; create the target directory if it does not exist.

    PUT /api/files/move

  • Write

    Renaming a File/Directory

    A JSON object identifying a file or directory to be renamed and the new name:

    PUT /api/files/rename

  • Write

    File Upload

    The file upload operation delivers a file in the Backendless file storage of your application. The return value of the upload operation is the public file URL. Backendless uses the following rules when assigning a URL to the uploaded file: Alternative documented variant: This operation allows creating a directory and subdirectories in the Backendless. You can create any number of subdirectories in one request.

    POST /api/files/{path}/{filename}

  • Write

    Create Hive

    Make sure to replace xxxx in the domain name in the request specification below to the one assigned to your application.

    POST /api/hive/{hive_name}

  • Write

    Rename Hive

    Make sure to replace xxxx in the domain name in the request specification below to the one assigned to your application.

    PUT /api/hive/{hive_name}

  • Write

    Set Keys and Values

    This operation modifies values associated with one or more keys. If the specified keys do not exist, new key-value pairs are created.

    PUT /api/hive/{hive_name}/key-value

  • Write

    Set Key-Value

    This operation modifies a value associated with the specified key. In case the specified key does not exists, a new key-value pair is created.

    PUT /api/hive/{hive_name}/key-value/{key}

  • Write

    Decrement

    This operation decrements the key's value by a specific number.

    PUT /api/hive/{hive_name}/key-value/{key}/decrement

  • Write

    Increment

    This operation increments the key's value by a specific number.

    PUT /api/hive/{hive_name}/key-value/{key}/increment

  • Write

    Add First

    This operation adds new values to the very beginning of a list.

    PUT /api/hive/{hive_name}/list/{key}/add-first

  • Write

    Add Last

    This operation adds new values to the very end of a list.

    PUT /api/hive/{hive_name}/list/{key}/add-last

  • Write

    Insert After

    This operation inserts a new value after an existing value in a list.

    PUT /api/hive/{hive_name}/list/{key}/insert-after

  • Write

    Insert Before

    This operation inserts a new value before an existing value in a list.

    PUT /api/hive/{hive_name}/list/{key}/insert-before

  • Write

    Set Values

    This operation updates a value for a key if it exists. In case the specified key does not exist, then a new key-value pair is added.

    PUT /api/hive/{hive_name}/map/{key}

  • Write

    Decrement

    This operation decrements the value of the specified key by a specific number.

    PUT /api/hive/{hive_name}/map/{key}/decrement/{key_name}

  • Write

    Increment

    This operation increments the value of the specified key by a specific number.

    PUT /api/hive/{hive_name}/map/{key}/increment/{key_name}

  • Write

    Overwrite Current Value

    This operation overwrites the value of a key.

    PUT /api/hive/{hive_name}/map/{key}/set-with-overwrite/{key_name}

  • Write

    Set Value By Key Name

    This operation replaces the value linked to a key in the map.

    PUT /api/hive/{hive_name}/map/{key}/set/{key_name}

  • Write

    Difference

    This operation finds the difference between the primary (first) set and all other specified sets. To find the difference, the operation subtracts identical values across multiple sets and returning the remainder (i.e. the difference) in a new set. The first set in the request is considered the main set whose remainder is left after the subtraction operation.

    POST /api/hive/{hive_name}/set/action/difference

  • Write

    Intersection

    This operation finds and returns identical values between two or more sets.

    POST /api/hive/{hive_name}/set/action/intersection

  • Write

    Union

    This operation creates a union of unique values from the specified sets. A union is a set made by combining unique elements of two or more sets.

    POST /api/hive/{hive_name}/set/action/union

  • Write

    Add Values

    This operation adds new elements to a set. Duplicate values are ignored.

    PUT /api/hive/{hive_name}/set/{key}/add

  • Write

    Difference

    This operation finds the difference between the primary (first) set and all other specified sets. To find the difference, the operation subtracts identical values across multiple sorted sets and returning the remainder (i.e. the difference) in a new sorted set. The first sorted set in the request is considered the main sorted set whose remainder is left after the subtraction operation.

    POST /api/hive/{hive_name}/sorted-set/action/difference

  • Write

    Intersection

    This operation finds and returns identical values between two or more sorted sets. When a value appears in more than one input sorted set, the resulting score is a sum of the scores from each sorted set.

    POST /api/hive/{hive_name}/sorted-set/action/intersection

  • Write

    Union

    This operation creates a union of values from the specified sorted sets. A union is a set made by combining the elements of two or more sets. When a value appears in more than one input sorted set, the resulting score is a sum of the scores from each sorted set.

    POST /api/hive/{hive_name}/sorted-set/action/union

  • Write

    Reset Last Operation Time

    The Hive system maintains a timer for every key that measures the number of seconds elapsed since the last operation. This operation resets the timer to zero seconds.

    PUT /api/hive/{hive_name}/{bucket_type}/action/touch

  • Write

    Clear Key Expiration Time

    This operation clears a timeout associated with a key. Note that all keys are created without timeouts by default, and you can set it by invoking the "Set Key Expiration - TTL" or the "Set Key Expiration - Unix time" operations.

    PUT /api/hive/{hive_name}/{bucket_type}/{key}/clear-expiration

  • Write

    Set Key Expiration - TTL

    This operation sets a time-to-live(TTL) timeout on a specific key. When the timeout expires, they key and the corresponding value are deleted. Note that, all keys are created without timeouts by default. This operation enables the timeout functionality.

    PUT /api/hive/{hive_name}/{bucket_type}/{key}/expire

  • Write

    Set Key Expiration - Unix Time

    This operation relies on the Unix time, which is the number of seconds elapsed since 1970-01-01 00:00:00 UTC till the present moment. The number of seconds must be passed to the operation in the Unix time format to set the timeout, for instance: the Unix time for October 20, 2022 is 1666213200 seconds. When a timeout is set for a key, the system deletes the key at the specified time. Note that all keys are created without timeouts by default. This operation provides a way to set an absolute timeout value as a timestamp.

    PUT /api/hive/{hive_name}/{bucket_type}/{key}/expire-at

  • Write

    Rename Key

    This operation renames a key. The corresponding value is not impacted. After the operation is complete, the value is available with the new key name.

    PUT /api/hive/{hive_name}/{bucket_type}/{key}/rename

  • Write

    Send Notification from a Push Template

    Optional parameters are shown in [square brackets]:

    POST /api/messaging/push/{template_name}

  • Write

    Device Registration API

    In order to receive push notifications from Backendless, a device must be registered using the API documented below. Device registration may optionally include a list of messaging channels and/or an expiration date/time when the registration should be canceled.

    POST /api/messaging/registrations

  • Write

    General API

    A Backendless application can publish messages to Backendless for subsequent distribution to subscribers. A message must be published to a channel. Backendless supports unlimited number of channels per application. Channels can be used as a filtering mechanism - subscribers see the messages published only to the channel they subscribe to. Alternative documented variant: Message publishing API supports the following scenarios:

    POST /api/messaging/{channel_name}

  • Write

    Subscribe for All Messages

    This API subscribes to a channel to receive all channel messages. Message retrieval requires a separate API call documented in the Retrieve Messages section of this guide. Alternative documented variant: Backendless message filtering is a powerful mechanism enabling conditional message delivery, interest-based subscriptions and private (point-to-point) messaging. To enable filtering, the subscription API documented below requires a special condition called selector which must be included in the API's request body. Backendless applies the selector to every message published into a channel and if the condition is true, the message is delivered to the subscriber.

    POST /api/messaging/{channel_name}/subscribe

  • Write

    Create Email Confirmation

    A confirmation email message includes a special link the user clicks to confirm their email address. When the link is clicked and the link is not expired, the user status changes from EMAIL_CONFIRMATION_PENDING to ENABLED . The email message delivered to the user is created from the Confirmation template located in Messaging > Emails in Backendless Console. There are scenarios when the link needs to be generated in your application logic, for instance, if you need to send it out via text message or if you need to generate the confirmation email dynamically.

    POST /api/users/createEmailConfirmationURL/{identity}

  • Write

    Backendless Login API

    Registered users can login using the API described below. The login operation requires two properties: one marked as user identity and the second is password . Backendless automatically assigns the "AuthenticatedUser" role to all successfully logged in users. The role can be used to differentiate access to various resources (data in the database, files, messaging channels) between authenticated users and guests.

    POST /api/users/login

  • Write

    Logout

    The Logout operation terminates user session and disassociates the AuthenticatedUser role from the subsequent requests made by the client application.

    GET /api/users/logout

  • Write

    OAuth2 Login API

    This API is used to "exchange" login provider's access token to the user object, it is used in Step 3 of the Login with Provider SDK flow. The API logs in externally authenticated user to Backendless. Alternative documented variant: The OAuth1 authorization protocol is only available for Twitter, use OAuth2 for other login providers.

    POST /api/users/oauth/{providerCode}/login

  • Write

    Get Authorization URL

    This API is used to obtain a URL for the login providers authorization (login) form. The API is used in the OAuth login approach without using login provider's SDK (see Step 1 in Login Without Provider's SDK ).

    POST /api/users/oauth/{providerCode}/request_url

  • Write

    User Registration

    The user registration API creates a user account in your application. A registration request must provide a user object as a collection of key/value properties. The collection must contain a property marked as identity as well as the "password" property. The default identity property is " email ", however, it can be changed in Backendless Console . Additionally, the "email" property is required if your Backendless application is configured to confirm email addresses for the registered users.

    POST /api/users/register

  • Write

    Guest Login API

    Backendless supports anonymous login, which is an operation of creating a "guest" user account. This functionality is useful when your application needs to provide some of its services to users prior to them registering as a fully functional user. For example, consider an application where users can add items to a shopping cart with a subsequent check out. To simplify the user experience, your application may allow adding items to the shopping cart before the user has completed the registration process. At the same time, you may want to have a persistent record in the database for the user with relationships between the user record and the pending order. This can be implemented using the anonymous login.

    POST /api/users/register/guest

  • Write

    Resend Email Confirmation

    This API resends the email confirmation email message to a user. It applies only to the apps which have the "Require email confirmation" option enabled. If the user status is "email confirmation pending", then an email with the confirmation link is resent, otherwise an error occurs.

    POST /api/users/resendconfirmation/{identity}

  • Write

    Password Reset

    Backendless supports two types of password reset:

    GET /api/users/restorepassword/{user_identity_property}

  • Write

    Update User Object

    User property values of the logged in users can be updated with an API operation described below. This operation is useful if an application needs to provide to the users the functionality for updating user profiles and registration properties. A user must be logged in to update his registration properties.

    PUT /api/users/{user_id}

  • Write

    Validating In-App Purchase

    The App Store and Google Play services provide a mechanism that allows validating the authenticity of an in-app purchase. It is used as a protection measure against fraudulent transactions. The receipt(iOS)/token(Android) becomes available in the app after the first in-app purchase, and depending on the platform can be validated using the API described below.

    POST /commerce/apple/verifyReceipt

  • Write

    Managing Subscriptions

    Backendless provides two APIs for Android platform that allow retrieving the current subscription status of an application, and also cancelling an active subscription.

    POST /commerce/googleplay/{packageName}/subscription/{subscriptionId}/purchases/{token}/cancel

  • Write

    Assigning a Role to a User

    This operation assigns a new role to a user.

    POST /{application_id}/{CLOUDCODE_api_key}/users/assignRole

  • Write

    Passwordless Login API

    A user can be logged in without a password using the API documented below.

    POST /{application_id}/{CLOUDCODE_api_key}/users/login

  • Write

    Password Verification

    When a user needs to change their password in your application, you may need to verify their existing password for security reasons. Since Backendless stores passwords in the encrypted format and never returns the password value, you need to use the API call documented below to implement password verification. The API checks the provided password value against the one stored in the database. User must be logged - Backendless verifies provided value for the currently logged in user.

    POST /{application_id}/{CLOUDCODE_api_key}/users/verifypassword

  • Destructive

    Permissions API

    Every data object in Backendless has its own access control list (ACL) - a matrix of operations and principals (application's users or roles). An intersection of an operation and a principal contains a permission which determines whether the principal has the right to execute the operation. These permission could be either grant or deny .

    PUT /api/data/{table_name}/permissions/{objectId}/bulk

  • Destructive

    Permissions API

    Every data object in Backendless has its own access control list (ACL) - a matrix of operations and principals (application's users or roles). An intersection of an operation and a principal contains a permission which determines whether the principal has the right to execute the operation. These permission could be either grant or deny .

    PUT /api/data/{table_name}/permissions/{permission_type}

  • Destructive

    Permissions API

    Every data object in Backendless has its own access control list (ACL) - a matrix of operations and principals (application's users or roles). An intersection of an operation and a principal contains a permission which determines whether the principal has the right to execute the operation. These permission could be either grant or deny .

    PUT /api/data/{table_name}/permissions/{permission_type}/{objectId}

  • Destructive

    Remove User

    This operation deletes a specific user from the Users data table. Alternative documented variant: Consider the following records in the employees data table:

    DELETE /api/data/{table_name}/{objectId}

  • Destructive

    Delete Objects from relation

    The API removes specific objects from a relationship with their parent. Alternative documented variant: The API deletes objects from a relationship with their parent. The objects are identified implicitly through a whereClause condition.

    DELETE /api/data/{table_name}/{parentObjectId}/{relationName}

  • Destructive

    Deleting a Directory

    The example below deletes the "async" directory.

    DELETE /api/files/{path}

  • Destructive

    Delete Hive

    Make sure to replace xxxx in the domain name in the request specification below to the one assigned to your application.

    DELETE /api/hive/{hive_name}

  • Destructive

    Delete Value

    This operation deletes specific values from a list.

    PUT /api/hive/{hive_name}/list/{key}/delete-value

  • Destructive

    Delete First

    This operation deletes values from the beginning of the list and returns them in the response.

    PUT /api/hive/{hive_name}/list/{key}/get-first-and-delete

  • Destructive

    Delete Last

    This operation deletes values from the end of the list and returns them in the response.

    PUT /api/hive/{hive_name}/list/{key}/get-last-and-delete

  • Destructive

    Delete By Key Name

    This operation deletes a single or multiple key-value pairs from the map.

    DELETE /api/hive/{hive_name}/map/{key}/by-obj-keys

  • Destructive

    Delete Random Key Items

    This operation returns the specified number of random elements and deletes them afterwards from a set.

    PUT /api/hive/{hive_name}/set/{key}/random

  • Destructive

    Delete Values

    This operation deletes specific elements from the set.

    DELETE /api/hive/{hive_name}/set/{key}/values

  • Destructive

    Delete Values By Rank Range

    This operation removes all items with rank between start and stop. Both start and stop ranks are zero-based indexes with the zero rank assigned to an item with the lowest score. For more information about the rank, refer to the Hive Overview section of this guide.

    DELETE /api/hive/{hive_name}/sorted-set/{key}/delete-by-rank

  • Destructive

    Delete Values By Score Range

    This operation deletes all items with a score between the specified minimum and maximum boundaries.

    DELETE /api/hive/{hive_name}/sorted-set/{key}/delete-by-score

  • Destructive

    Delete Values With Max Score

    This operation retrieves and deletes items with the highest scores from the sorted set. You can specify the number of values to retrieve and delete.

    PUT /api/hive/{hive_name}/sorted-set/{key}/get-with-max-score-and-delete

  • Destructive

    Delete Values With Min Score

    This operation retrieves and deletes items with the lowest scores from the sorted set. You can specify the number of values to retrieve and delete.

    PUT /api/hive/{hive_name}/sorted-set/{key}/get-with-min-score-and-delete

  • Destructive

    Delete Value(s)

    This operation deletes multiple values from a sorted set.

    DELETE /api/hive/{hive_name}/sorted-set/{key}/values

  • Destructive

    Delete Keys

    This operation deletes multiple keys and the corresponding values from a Hive store.

    DELETE /api/hive/{hive_name}/{bucket_type}

  • Destructive

    Delete Key

    This operation deletes a specific key and the corresponding value from a Hive store.

    DELETE /api/hive/{hive_name}/{bucket_type}/{key}

  • Destructive

    Delete Channel API

    This API facilitates the removal of a messaging channel within the system. It is classified as "privileged," indicating that its use is restricted to Cloud Code, a secure environment. Deleting a channel automatically unsubscribes all its current subscribers.

    DELETE /api/messaging/channels/{channel_name}

  • Destructive

    Cancel Device Registration

    To cancel the registration of a device with Backendless, an application can use the API described below:

    DELETE /api/messaging/registrations/{device_id}

  • Destructive

    Unit of Work API

    The heart of the Backendless Transactions API is a request called UnitOfWork . It used by the client applications to compose a transaction. Composing a transaction means adding various database operations to a unit of work. These operations may be "linked" between each other by using the output/result on one operation as the input for another. Alternative documented variant: With this operation, you can either update an existing object or insert a new one into the database. To update an existing object, the operation locates it using its objectId value. If the object cannot be found, the operation inserts a new object into the data table with the specified objectId . Alternative documented variant: When performing this operation, the system attempts to locate and update a specific set of objects first. If some or all of these objects cannot be found, any objects specified in the operation's invocation are inserted into the data table, while any remaining objects are simply updated. This process is based on using the unique identifiers ( objectId ) of the records to apply any necessary changes in the data table.

    POST /api/transaction/unit-of-work

  • Destructive

    Unassigning a Role from a User

    Users may have different roles, and in some cases you may want to unassign a specific role from the user by invoking the operation described in this topic.

    POST /api/users/unassignRole

  • Destructive

    Cancel Scheduled Message

    Delayed delivery as well as repeated publish messages can be canceled using the API documented below:

    DELETE /messaging/{message_id}

  • Destructive

    Enable User

    This operation changes the user status to ENABLED . Alternative documented variant: This operation changes the user status to DISABLED .

    PUT /{application_id}/{CLOUDCODE_api_key}/users/{user_objectId}/status

See How connections work for access and permissions, or browse all integrations.