Backendless

Backendless is a visual app development and backend-as-a-service (BaaS) platform that exposes a full set of REST APIs for data persistence, user management, file storage, publish-subscribe messaging, push notifications, geolocation, caching, and atomic counters, plus serverless Cloud Code (custom API services and timers). Requests are authenticated with an application id and REST API key carried in the URL path and a user-token header for authenticated sessions.

7 APIs 0 Features

BaaSBackend as a ServiceVisual DevelopmentLow CodeDatabaseRealtime

APIs

Backendless Data Service API

CRUD persistence over schema-backed tables - save, update, upsert, and delete single or bulk objects, plus rich search with where clauses, paging, sorting, relations, grouping, ...

Backendless User Service API

User registration, login, logout, password recovery, email confirmation, current-user lookup, and role assignment. Login returns a user-token used as a header on subsequent auth...

Backendless File Service API

Upload, download, copy, move, rename, and delete files and directories in the hosted file repository, with directory listing and permission controls.

Backendless Messaging and Push API

Publish-subscribe message exchange over named channels, polling-based message retrieval, mobile push notifications (singlecast/broadcast), device registration, and templated ema...

Backendless Geo Service API

Geo point management organized into categories with metadata, plus radius and rectangle proximity search and relative-distance queries against stored geo points.

Backendless Cache and Atomic Counters API

Server-side key/value cache with put, get, contains, expire, and delete operations, and thread-safe atomic counters supporting increment, decrement, add-and-get, get, compare-an...

Backendless Cloud Code API

Invoke developer-defined serverless API services and methods deployed as Cloud Code, alongside event handlers and scheduled timers that run custom business logic in the Backendl...

Collections

Backendless REST API

OPEN

Pricing Plans

Backendless Plans Pricing

4 plans

PLANS

Rate Limits

Backendless Rate Limits

6 limits

RATE LIMITS

FinOps

Backendless Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: Backendless REST API
  version: '1.0'
request:
  auth:
    type: apikey
    key: user-token
    value: '{{userToken}}'
    in: header
items:
- info:
    name: Data
    type: folder
  items:
  - info:
      name: Save a single object
      type: http
    http:
      method: POST
      url: https://api.backendless.com/{app-id}/{rest-api-key}/data/{table-name}
      body:
        type: json
        data: '{"name":"Bob","age":20}'
    docs: Persists a new object into the named table; Backendless assigns the objectId.
  - info:
      name: Find objects
      type: http
    http:
      method: GET
      url: https://api.backendless.com/{app-id}/{rest-api-key}/data/{table-name}?where=&pageSize=10&offset=0&sortBy=
    docs: Retrieves a collection of objects with optional where, paging, sorting, relations, and grouping.
  - info:
      name: Retrieve object by id
      type: http
    http:
      method: GET
      url: https://api.backendless.com/{app-id}/{rest-api-key}/data/{table-name}/{object-id}
    docs: Retrieves a single object by its objectId.
  - info:
      name: Update a single object
      type: http
    http:
      method: PUT
      url: https://api.backendless.com/{app-id}/{rest-api-key}/data/{table-name}/{object-id}
      body:
        type: json
        data: '{"age":21}'
    docs: Updates the supplied properties for the identified object.
  - info:
      name: Delete a single object
      type: http
    http:
      method: DELETE
      url: https://api.backendless.com/{app-id}/{rest-api-key}/data/{table-name}/{object-id}
    docs: Deletes a single object and returns the deletion timestamp.
  - info:
      name: Count objects
      type: http
    http:
      method: GET
      url: https://api.backendless.com/{app-id}/{rest-api-key}/data/{table-name}/count?where=
    docs: Returns the number of objects matching an optional where clause.
- info:
    name: Users
    type: folder
  items:
  - info:
      name: Register a new user
      type: http
    http:
      method: POST
      url: https://api.backendless.com/{app-id}/{rest-api-key}/users/register
      body:
        type: json
        data: '{"email":"user@example.com","password":"secret"}'
    docs: Creates a new user in the Users table.
  - info:
      name: Log in a user
      type: http
    http:
      method: POST
      url: https://api.backendless.com/{app-id}/{rest-api-key}/users/login
      body:
        type: json
        data: '{"login":"user@example.com","password":"secret"}'
    docs: Authenticates a user and returns a user-token for subsequent requests.
  - info:
      name: Log out the current user
      type: http
    http:
      method: GET
      url: https://api.backendless.com/{app-id}/{rest-api-key}/users/logout
    docs: Invalidates the current user session.
  - info:
      name: Initiate password recovery
      type: http
    http:
      method: GET
      url: https://api.backendless.com/{app-id}/{rest-api-key}/users/restorepassword/{identity}
    docs: Sends a password recovery email to the given user identity.
- info:
    name: Files
    type: folder
  items:
  - info:
      name: Upload a file
      type: http
    http:
      method: POST
      url: https://api.backendless.com/{app-id}/{rest-api-key}/files/{path}?overwrite=true
      body:
        type: multipart-form
        data: []
    docs: Uploads a file to the given path, creating missing directories.
  - info:
      name: Delete a file or directory
      type: http
    http:
      method: DELETE
      url: https://api.backendless.com/{app-id}/{rest-api-key}/files/{path}
    docs: Deletes a file or directory from the file repository.
- info:
    name: Messaging
    type: folder
  items:
  - info:
      name: Publish a message
      type: http
    http:
      method: POST
      url: https://api.backendless.com/{app-id}/{rest-api-key}/messaging/{channel-name}
      body:
        type: json
        data: '{"message":"Hello"}'
    docs: Publishes a message to a channel; the same endpoint dispatches push notifications.
  - info:
      name: Send a basic email
      type: http
    http:
      method: POST
      url: https://api.backendless.com/{app-id}/{rest-api-key}/messaging/email
      body:
        type: json
        data: '{"subject":"Hello","to":["user@example.com"],"bodyparts":{"textmessage":"Hi there"}}'
    docs: Sends a basic email to one or more recipients.
- info:
    name: Geo
    type: folder
  items:
  - info:
      name: Search geo points
      type: http
    http:
      method: GET
      url: https://api.backendless.com/{app-id}/{rest-api-key}/geo/points?categories=Default&lat=37.77&lon=-122.41&radius=1000&units=METERS
    docs: Finds geo points by category and proximity (radius search).
  - info:
      name: Add a geo point
      type: http
    http:
      method: POST
      url: https://api.backendless.com/{app-id}/{rest-api-key}/geo/points
      body:
        type: json
        data: '{"latitude":37.77,"longitude":-122.41,"categories":["Default"]}'
    docs: Adds or updates a geo point.
- info:
    name: Cache
    type: folder
  items:
  - info:
      name: Put a value into cache
      type: http
    http:
      method: PUT
      url: https://api.backendless.com/{app-id}/{rest-api-key}/cache/{key}?timeout=60000
      body:
        type: json
        data: '{"value":"cached"}'
    docs: Stores a value in the cache with an optional TTL in milliseconds.
  - info:
      name: Retrieve a cached value
      type: http
    http:
      method: GET
      url: https://api.backendless.com/{app-id}/{rest-api-key}/cache/{key}
    docs: Retrieves a cached value by key.
- info:
    name: Counters
    type: folder
  items:
  - info:
      name: Increment by 1 and return current
      type: http
    http:
      method: PUT
      url: https://api.backendless.com/{app-id}/{rest-api-key}/counters/{counter-name}/increment/get
    docs: Atomically increments the counter by one and returns the new value.
  - info:
      name: Get the current counter value
      type: http
    http:
      method: GET
      url: https://api.backendless.com/{app-id}/{rest-api-key}/counters/{counter-name}/get
    docs: Returns the current counter value.
- info:
    name: CloudCode
    type: folder
  items:
  - info:
      name: Invoke a custom Cloud Code service method
      type: http
    http:
      method: POST
      url: https://api.backendless.com/{app-id}/{rest-api-key}/services/{service-name}/{method-name}
      body:
        type: json
        data: '{}'
    docs: Calls a method on a developer-defined serverless API service deployed to Cloud Code.