All REST Endpoints
Analytics Collector
The Analytics Collector API lets you use custom analytic events to store information about how users use your app. This API is used by the mobile client SDK. You can also call the API from your custom code.
- Add Events to the Analytics Database
- Method: postPath:
/mobile/platform/analytics/events
Analytics Data Management
Use the Analytics Data Management API to manage stored analytics data.
- Delete All
- Method: postPath:
/mobile/system/analyticsDataManagement/deletion
- Delete Job
- Method: deletePath:
/mobile/system/analyticsDataManagement/jobs/{id}
- Purge All
- Method: postPath:
/mobile/system/analyticsDataManagement/purge
- Retrieve Job
- Method: getPath:
/mobile/system/analyticsDataManagement/jobs/{id}
- Retrieve Jobs
- Method: getPath:
/mobile/system/analyticsDataManagement/jobs
- Shrink Tables
- Method: postPath:
/mobile/system/analyticsDataManagement/shrink
Analytics Export
The Analytics Export API lets you export your analytic event data and your API call metadata.
- Retrieve Event and API Data
- Method: postPath:
/mobile/system/analyticsExport/export/request
App Policies
The App Policies API lets you retrieve a backend's properties. These are the properties from the backend's App Policies page.
- Retrieve App Policies
- Method: getPath:
/mobile/platform/appconfig/client
Auth Token
Use this API to exchange a token issued by an external identity provider for a mobile user access token.
- Exchange Token
- Method: postPath:
/mobile/platform/auth/token
Database Access
The Database API provides operations to add, update, view, and delete rows in a database table. When you add a row, the API implicitly creates the table if it doesn't exist. For security reasons, you can access these operations only from custom API implementations by using the custom code SDK. You can't make direct requests from client applications. This API is included in this reference merely to describe the request and response bodies for the custom code SDK calls.
- Add or Update Rows
- Method: putPath:
/mobile/platform/database/objects/{table}
- Add Rows
- Method: postPath:
/mobile/platform/database/objects/{table}
- Delete a Row with a 1-Column Key
- Method: deletePath:
/mobile/platform/database/objects/{table}/{id}
- Delete a Row with a 2-Column Key
- Method: deletePath:
/mobile/platform/database/objects/{table}/{id}/{id2}
- Delete a Row with a 3-Column Key
- Method: deletePath:
/mobile/platform/database/objects/{table}/{id}/{id2}/{id3}
- Delete a Row with a 4-Column Key
- Method: deletePath:
/mobile/platform/database/objects/{table}/{id}/{id2}/{id3}/{id4}
- Get a Row with a 1-Column Key
- Method: getPath:
/mobile/platform/database/objects/{table}/{id}
- Get a Row with a 2-Column Key
- Method: getPath:
/mobile/platform/database/objects/{table}/{id}/{id2}
- Get a Row with a 3-Column Key
- Method: getPath:
/mobile/platform/database/objects/{table}/{id}/{id2}/{id3}
- Get a Row with a 4-Column Key
- Method: getPath:
/mobile/platform/database/objects/{table}/{id}/{id2}/{id3}/{id4}
- Get Rows
- Method: getPath:
/mobile/platform/database/objects/{table}
Database Management
Use the Database Management API to manage your database tables.
- Create a Table
- Method: postPath:
/mobile/system/databaseManagement/tables
- Create an Index
- Method: postPath:
/mobile/system/databaseManagement/tables/{table}/indexes
- Remove a Table
- Method: deletePath:
/mobile/system/databaseManagement/tables/{table}
- Remove an Index
- Method: deletePath:
/mobile/system/databaseManagement/tables/{table}/indexes/{index}
- Remove and Re-Create a Table
- Method: putPath:
/mobile/system/databaseManagement/tables/{table}
- Return Metadata About All Tables
- Method: getPath:
/mobile/system/databaseManagement/tables
- Return Metadata for a Table
- Method: getPath:
/mobile/system/databaseManagement/tables/{table}
Location
The Location API lets you query about location devices, assets they're associated with, and the places where they're located.
- Return a Device by ID
- Method: getPath:
/mobile/platform/location/devices/{id}
- Return a Device by Name
- Method: getPath:
/mobile/platform/location/devices
- Return a Place by ID
- Method: getPath:
/mobile/platform/location/places/{id}
- Return a Place by Name
- Method: getPath:
/mobile/platform/location/places
- Return an Asset by ID
- Method: getPath:
/mobile/platform/location/assets/{id}
- Return an Asset by Name
- Method: getPath:
/mobile/platform/location/assets
- Return Assets by Query
- Method: postPath:
/mobile/platform/location/assets/query
- Return Devices by Query
- Method: postPath:
/mobile/platform/location/devices/query
- Return Places by Query
- Method: postPath:
/mobile/platform/location/places/query
Location Management
The Location Management API lets team members with the MobileEnvironment_System role create, update, and delete location devices, places, and assets.
- Add Assets
- Method: postPath:
/mobile/system/locationManagement/assets
- Add Assets from File
- Method: postPath:
/mobile/system/locationManagement/assets/upload
- Add Devices
- Method: postPath:
/mobile/system/locationManagement/devices
- Add Devices from File
- Method: postPath:
/mobile/system/locationManagement/devices/upload
- Add Places
- Method: postPath:
/mobile/system/locationManagement/places
- Add Places from File
- Method: postPath:
/mobile/system/locationManagement/places/upload
- Delete Asset
- Method: deletePath:
/mobile/system/locationManagement/assets/{id}
- Delete Device
- Method: deletePath:
/mobile/system/locationManagement/devices/{id}
- Delete Multiple Assets
- Method: deletePath:
/mobile/system/locationManagement/assets
- Delete Multiple Devices
- Method: deletePath:
/mobile/system/locationManagement/devices
- Delete Multiple Places
- Method: deletePath:
/mobile/system/locationManagement/places
- Delete Place
- Method: deletePath:
/mobile/system/locationManagement/places/{id}
- Update Asset
- Method: putPath:
/mobile/system/locationManagement/assets/{id}
- Update Device
- Method: putPath:
/mobile/system/locationManagement/devices/{id}
- Update Place
- Method: putPath:
/mobile/system/locationManagement/places/{id}
Mobile Devices
The Mobile Devices API lets you configure which devices that are running a mobile app can receive notifications.
- Deregister Mobile Client
- Method: postPath:
/mobile/platform/devices/deregister
- Register Mobile Client
- Method: postPath:
/mobile/platform/devices/register
Mobile Users
The Mobile User Management API allows mobile apps to get information about the current mobile, virtual, or social user. You also can use this API to update the current mobile user's custom properties. These are the properties that you have added to the realm that the member belongs to.
- Retrieve User Information
- Method: getPath:
/mobile/platform/users/{username}
- Update User Information
- Method: patchPath:
/mobile/platform/users/{username}
- Update User Information
- Method: putPath:
/mobile/platform/users/{username}
Mobile Users Extended Operations
The Mobile User Management Extended API allows mobile apps to get information about the current mobile, virtual, or social user. This extended API enables you to retrieve the current mobile or virtual user's roles.
- Retrieve Extended User Information
- Method: getPath:
/mobile/platform/extended/users/{username}
Notifications
Team members with the MobileEnvironment_Notifications role can use the Notifications API to create, cancel, and retrieve notifications. This API supports Apple Push Notification Service, Windows Push Notification Service, Fire Based Cloud Messaging, and Google Cloud Messaging.
- Create Notification
- Method: postPath:
/mobile/system/notifications/notifications/
- Delete Notification
- Method: deletePath:
/mobile/system/notifications/notifications/{id}
- Return a Notification
- Method: getPath:
/mobile/system/notifications/notifications/{id}
- Return Notifications by Query
- Method: getPath:
/mobile/system/notifications/notifications/
Storage
The Storage API lets you store objects in the cloud. An object can be text, JSON, or a binary object such as an image. The objects are grouped by collection.
- Remove an Object by ID
- Method: deletePath:
/mobile/platform/storage/collections/{collection}/objects/{object}
- Return a List of Collections
- Method: getPath:
/mobile/platform/storage/collections
- Return a List of Objects
- Method: getPath:
/mobile/platform/storage/collections/{collection}/objects
- Return an Object
- Method: getPath:
/mobile/platform/storage/collections/{collection}/objects/{object}
- Return Collection Metadata
- Method: getPath:
/mobile/platform/storage/collections/{collection}
- Return Collection Metadata
- Method: headPath:
/mobile/platform/storage/collections/{collection}
- Return Object Metadata
- Method: headPath:
/mobile/platform/storage/collections/{collection}/objects/{object}
- Store an Object
- Method: postPath:
/mobile/platform/storage/collections/{collection}/objects
- Store an Object by ID
- Method: putPath:
/mobile/platform/storage/collections/{collection}/objects/{object}
Tools
The Tools API lets you upload custom API implementations into MCS.
- Upload Custom API Implementation
- Method: postPath:
/mobile/tools/1.0/apis/{id}/implementations