Note: For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.
REST API for the MobileFirst Server administration service
The REST API provides several services to administer runtime adapters, applications, devices, audit, transactions, security, and push notifications.
The REST service API for adapters and applications for each runtime is in /management-apis/2.0/runtimes/runtime-name/, where runtime-name is the name of the runtime that is administered through the REST service. Then, the type of object addressed by the service is identified, together with the appropriate method. For example, /management-apis/2.0/runtimes/runtime-name/Adapters (POST) refers to the service for deploying an adapter.
- Adapter (GET)
Retrieves metadata of a specific adapter. - Adapter (DELETE)
Deletes a specific adapter. - Adapter (POST)
Deploys an adapter. - Adapters (GET)
Retrieves metadata for the list of deployed adapters. - Adapter Configuration (GET)
Retrieves the user configuration of a specific adapter. - Adapter configuration (PUT)
Sets the user configuration of a specific adapter. - Application Authenticity (DELETE)
Deletes specific application authenticity data. - Application Configuration (GET)
Retrieves the configuration of a specific application version. - Application Configuration (PUT)
Sets the configuration of a specific application version. - Application Descriptor (GET)
Retrieves the application descriptor of a specific application version. - Application Environment (GET)
Retrieves the metadata of a specific application environment. - Application (GET)
Retrieves the metadata of a specific application. - Application (POST)
Deploys an application. - Applications (GET)
Retrieves metadata for the list of deployed applications. - Application License Configuration (POST)
Deploys a license configuration for an application. - Application license configuration (GET)
Retrieves the metadata of a specific license configuration for the application. - Application Version (GET)
Retrieves the metadata of a specific application version. - Application Version (DELETE)
Deletes a specific application version. - Audit (GET)
Returns Audit Information. - Confidential Clients (GET)
Retrieves the confidential clients list of a specific runtime. - Confidential Clients (PUT)
Sets the confidential clients list of a specific runtime. - Create Subscription (POST)
Creates a new subscription for a tag. - Create Tag (POST)
Creates a tag with a unique name in the application that is referenced by the applicationId parameter. - Delete APNs settings (DELETE)
Deletes the APNs settings to the application referenced by the application name. - Delete GCM settings (DELETE)
Deletes the GCM settings to the application referenced by the application name. - Delete WNS settings (DELETE)
Deletes the WNS settings from the application referenced by the application name. - Delete Message (DELETE)
Deletes a message identified by the messageId parameter. - Delete Subscription (DELETE)
Unsubscribes the device from the tag by using the subscription identifier. This method deletes neither the device registration nor the tag. - Delete Tag (DELETE)
Deletes the tag in the application. - Deploy (POST)
Deploys a multipart compressed file. - Deploy Application Authenticity Data (POST)
Deploys application authenticity data for a specific application version. - Deploy a web resource (POST)
deploy a web resource zip for a specific application version. - Device Application Status (PUT)
Changes the status of a specific application on a specific device. - Device Status (PUT)
Changes the status of a specific device. - Device (DELETE)
Deletes all metadata of a specific device. - Devices (GET)
Retrieves metadata for the list of devices that accessed this project. - Diagnostic Service (GET)
Retrieves diagnostic information for administration, runtime, configuration (live update), and push services. - Export adapter resources (GET)
Retrieves a compressed file that contains all or selected resources for specific adapters for this runtime. - Export adapters (GET)
Retrieves a compressed file that contains all or selected adapter resources for this runtime. - Export application environment (GET)
Retrieves a compressed binary file that contains all or selected application environment-specific resources for this runtime. - Export application environment resources (GET)
Retrieves a compressed binary resource for a specific version of an application environment for this runtime. - Export application resources (GET)
Retrieves a compressed file that contains all or selected application-specific resources for this runtime. - Export applications (GET)
Retrieves a compressed file that contains all or selected application resources for this runtime. - Export resources (GET)
Retrieves a compressed file (.zip) that contains all the specified resources. - Export runtime resources (GET)
Retrieves a compressed file that contains all or selected runtime-specific resources. - Farm topology members (GET)
Retrieves the list of members of the farm. - Farm topology members (DELETE)
Unregisters a farm node. - Get Message (GET)
Retrieves information about a message identified by its messageId parameter. - Get Tags (GET)
Retrieves all or a subset of tags in the application. - Get APNs Settings (GET)
Retrieves APNs credentials for the application. - Get GCM Settings (GET)
Retrieves GCM credentials for the application. - Get WNS Settings (GET)
Retrieves WNS credentials for the application. - Global Configuration (GET)
Retrieves information about the global configuration. - Keystore (GET)
Retrieves keystore properties for a deployed keystore of a runtime. - Keystore (POST)
Deploy a keystore for a runtime. - Keystore (DELETE)
Deletes a keystore from the runtime. - License configuration (DELETE)
Deletes a license configuration for the application name. - Push Device Registration (GET)
Retrieves all or a subset of existing device registrations to the push service. - Push Device Registration (DELETE)
Deletes(unregisters) an existing device registration from the push service. - Push Device Subscription (GET)
Retrieves all or a subset of existing subscriptions. - Register Application with Push Service (POST)
Registers an application with the push server. - Remove Subscription (DELETE)
Unsubscribes the specified device from a tag. - Retrieve Device Registration (GET)
Retrieves an existing device registration to the push service. - Retrieve Tag (GET)
Retrieves the specified tag in the application. - Retrieve Web Resource (GET)
Retrieves the metadata of a web resource for a specific application version. - Retrieve Subscription to Push Service. (GET)
The subscription referenced by the subscription identifier is retrieved. - Runtime Configuration (GET)
Retrieves the user configuration of a specific runtime. - Runtime configuration (PUT)
Sets the user configuration of a specific runtime. - Runtime (GET)
Retrieves metadata for a specific runtime. - Runtime (DELETE)
Deletes a specific runtime. - Runtime Lock (GET)
Retrieves information about the transaction lock of a runtime. - Runtime Lock (DELETE)
Forces the release of the transaction lock of a runtime. - Runtimes (GET)
Retrieves metadata for the list of runtimes. - Send Bulk Messages (POST)
Send bulk messages by specifying various options. - Send Message (POST)
Sends message with different options. - Transaction (GET)
Retrieves information about a specific transaction. - Transactions (GET)
Retrieves information of all transactions. - Update Device Registration (PUT)
Updates push device registration with the new user ID or the specified token. In most use cases, only the user ID is updated. - Update APNs settings (PUT)
Uploads an APNs certificate to the application referenced by the application name. - Update GCM settings (PUT)
Uploads a GCM certificate to the application referenced by the application name. - Update WNS Settings (PUT)
Uploads an WNS certificate to the application referenced by the application name. - Update Tag Information (PUT)
Updates the tag that is idenfitied by the tagName parameter for the application referenced by the application name.
Parent topic: API reference