Introduction

Mobile Foundation service provides a way to quickly set up a MobileFirst server environment on IBM Cloud. You can then develop, test, and manage mobile apps from this cloud environment. Mobile Foundation provides users an easy and guided way to set up MobileFirst Server environment on IBM Cloud.

Mobile Foundation provides APIs to administer the resources such as applications, adapters, Push, APNS, GCS, WNS, application configurations, device configurations and much more. For more, see: Onboarding with Mobile Foundation.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

Pagination

Some API requests might return a large number of results. To avoid performance issues, these results are returned one page at a time, with a limited number of results on each page. GET requests for the some of the resources use pagination

To override the default page size, use the pageSize query parameter.

Methods

Get Adapters

Retrieves metadata for the list of deployed adapters.

GET /runtimes/mfp/adapters
Request

Query Parameters

  • The bookmark for the page if only a part of the list (a page) should be returned. If a bookmark is specified, the offset parameter is ignored.

    Example: ABC

  • WhetherTo show runtimeInfo as part of each adapter.

    Example: true

  • The locale used for error messages.

    Example: en-US

  • The offset from the beginning of the list if only a part of the list (a page) should be returned.

    Example: 2

  • The sort mode. By default, the elements are sorted in increasing order. If the sort mode starts with - (minus sign), the elements are sorted in decreasing order. Possible sort modes are displayName, deployTime. The default sort mode is displayName.

    Example:
  • The number of elements if only a part of the list (a page) should be returned. The default value is 100.

    Example: 50

Response

Status Code

  • Successfully retrieved list of adapters.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application is not found.

  • An internal error occurred.

Example responses

Deploy adapter

Deploys an adapter. The transaction first checks whether the input deployable is valid. Then, it transfers the deployable to the database and to the runtime. This transaction can run synchronously or asynchronously. If the transaction is processed asynchronously, the REST service returns before the transaction is completed. In this case, you can query the transaction result later with the transaction REST service.

POST /runtimes/mfp/adapters
Request

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. The default mode is synchronous processing.

    Example: true

  • The locale used for error messages.

    Example: de_DE

Response

Status Code

  • Successfully deployed the adapter.

  • No deployable data is provided.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found or not running

  • An internal error occurred.

No Sample Response

This method does not specify any sample responses.

Get Adapter

Retrieves the metadata of a specific adapter.

GET /runtimes/mfp/adapters/{adaptername}
Request

Path Parameters

  • The name of the adapter.

    Example: WatsonToneAnalyzer

Query Parameters

  • The locale used for error messages.

    Example: en-US

Response

Status Code

  • Successfully retrieved metadata of the specified adapter.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application is not found.

  • An internal error occurred.

Example responses

Delete Adapter

Deletes a specific adapter. This transaction can run synchronously or asynchronously. If the transaction is processed asynchronously, the REST service returns before the transaction is completed. In this case, you can query the transaction result later with the transaction REST service.

DELETE /runtimes/mfp/adapters/{adaptername}
Request

Path Parameters

  • The name of the adapter.

    Example: WatsonToneAnalyzer

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. The default mode is synchronous processing.

    Example: true

  • The locale used for error messages.

    Example: de_DE

Response

Status Code

  • Successfully deleted the adapter.

  • No deployable data is provided.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found or not running.

  • An internal error occurred.

Example responses

Get Adapter Configuration

Retrieves the user configuration of a specific adapter.

GET /runtimes/mfp/adapters/{adaptername}/config
Request

Path Parameters

  • The name of the adapter.

    Example: WatsonToneAnalyzer

Query Parameters

  • If the parameter is set to true (default value), the configuration is a flat list of properties. If the parameter is set to false, the configuration is a hierarchy of objects.

  • The locale used for error messages.

  • If mode is not specified, the transaction returns the current user configuration. If the mode defaults is specified, the transaction returns the default configuration.

Response

Status Code

  • The user configuration of the specified adapter.

  • The user is not authorized to call this service.

  • The corresponding runtime or the adapter is not found.

  • An internal error occurred.

Example responses

Update Adapter Configuration

Sets the user configuration of a specific adapter.

PUT /runtimes/mfp/adapters/{adaptername}/config
Request

Path Parameters

  • The name of the adapter.

    Example: WatsonToneAnalyzer

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. The default mode is synchronous processing.

  • The locale used for error messages

Response

Status Code

  • The user configuration of the specified adapter.

  • The payload is invalid.

  • The user is not authorized to call this service.

  • The corresponding runtime or the adapter is not found.

  • An internal error occurred.

Example responses

Adapter Generator

Generates an adapter from an OpenAPI (a.k.a. Swagger) specification of a microservice.

POST /runtimes/mfp/mfpadaptergenerator/adapterapi/generate
Request

Form Parameters

  • OpenAPI specification file (.json/.yaml).

  • If source code is required, this parameter should be set to true.

Response

Status Code

  • Downloads an Adapter File/Adapter Source Code.

  • Unauthorized access.

  • Precondition Failed.

  • An internal error occurred.

No Sample Response

This method does not specify any sample responses.

Get registered Applications

Get a list of applications registered with the Mobile Foundation server.

GET /runtimes/mfp/applications
Request

Query Parameters

  • The bookmark for the page if only a part of the list (a page) should be returned. If a bookmark is specified, the offset parameter is ignored.

    Example: ABC

  • Whether an expanded version of the result should be shown. If this parameter is set to false, only a flat list of applications are returned. If the parameter is set to true, the entire hierarchy of environment and versions is returned, too.

    Example: true

  • The locale used for error messages.

    Example: en-US

  • The offset from the beginning of the list if only a part of the list (a page) should be returned.

    Example: 2

  • The sort mode. By default, the elements are sorted in increasing order. If the sort mode starts with - (minus sign), the elements are sorted in decreasing order. Possible sort modes are displayName, deployTime. The default sort mode is displayName.

    Example:
  • The number of elements if only a part of the list (a page) should be returned. The default value is '100'.

    Example: 50

Response

Status Code

  • Successfully retrieved applications

  • The user is not authorized to call this service.

  • The corresponding runtime or the application is not found.

  • An internal error occurred.

Example responses

Register an application

Registers an application in Mobile Foundation server.

POST /runtimes/mfp/applications
Request
Response

Status Code

  • Successfully created the application.

  • No deployable data is provided.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found or not running

  • An internal error occurred.

Example responses

Get Application

Retrieves the metadata of a specific application.

GET /runtimes/mfp/applications/{appname}
Request

Path Parameters

  • The name of the application.

    Example: com.example.android

Query Parameters

  • The locale used for error messages.

    Example: en-US

Response

Status Code

  • Successfully retrieved application

  • The user is not authorized to call this service.

  • The corresponding runtime or the application is not found.

  • An internal error occurred.

Example responses

Delete Application Authenticity

Deletes specific application authenticity data.

DELETE /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}/authenticity
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed synchronously.

  • The locale used for error messages.

Response

Status Code

  • Deletes application authenticity.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Deploy Application Authenticity

Deploys application authenticity data for a specific application version.

POST /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}/authenticity
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed synchronously.

  • The locale used for error messages.

Response

Status Code

  • The metadata of the deployable.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Deploy Application Authenticity Validation Type

Sets the app authenticity validation type for a specific application version.

POST /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}/authenticityValidationType
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed synchronously.

  • The locale used for error messages.

Form Parameters

  • The validation type to be set. The allowed values are 'dynamic' and 'static'.

Response

Status Code

  • Successfully updated app authenticaity validation type for the given application version.

  • No deployable data is provided.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

No Sample Response

This method does not specify any sample responses.

Get Application Configuration

Retrieves the configuration of a specific application version.

GET /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}/config
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • If this parameter is set to true (which is the default value), the configuration is returned as a flat list of properties. Otherwise, it is returned as a hierarchy of objects.

  • The locale used for error messages.

  • If mode is not specified, the method returns the current user configuration. If the defaults mode is specified, the method returns the default configuration.

Response

Status Code

  • The configuration of the specified application version.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Update Application Configuration

Sets the configuration of a specific application version.

PUT /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}/config
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed in synchronous mode.

  • The locale used for error messages.

Response

Status Code

  • The configuration of the specified application version.

  • The payload is invalid.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Get Application Descriptor

Retrieves the application descriptor of a specific application version.

GET /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}/descriptor
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The application descriptor of the specified application version.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Get Application Environment

Retrieves the metadata of a specific application environment.

GET /runtimes/mfp/applications/{application-name}/{application-env}
Request

Path Parameters

  • The name of the application.

  • The application environment.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The metadata of the specified application environment.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Delete Application Version

Deletes a specific application version.

DELETE /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed in synchronous mode.

  • The locale used for error messages.

Response

Status Code

  • The application descriptor of the specified application version.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Get Application Version

Retrieves the metadata of a specific application version.

GET /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The metadata of the specified application version.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Deploy Web Resource

Deploys a web resource compressed file (.zip).

POST /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}/web
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed synchronously.

  • The locale used for error messages.

Form Parameters

  • Deployable web resource (.zip).

Response

Status Code

  • The metadata of the deployable.

  • No deployable data is provided.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Get Web Resource

Retrieves the metadata of a web resource for a specific application version.

GET /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}/web
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The metadata of the web resource for the specified application version.

  • No deployable data is provided.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Enable or Disable Application Authenticity

Enables or Disables the app authenticity for a specific application version.

POST /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}/enableAuthenticity
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed synchronously.

  • The locale used for error messages.

Form Parameters

  • (Boolean) Whether to enable or disable app authenticity. The allowed values are true and false.

Response

Status Code

  • Successfully enabled or disabled authenticity.

  • No deployable data is provided.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

No Sample Response

This method does not specify any sample responses.

Reset Application Authenticity

Resets the authenticity data for a specific application version.

POST /runtimes/mfp/applications/{application-name}/{application-env}/{application-version}/resetAuthenticity
Request

Path Parameters

  • The name of the application.

  • The application environment.

  • The application version number.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed synchronously.

  • The locale used for error messages.

Response

Status Code

  • Successfully reset authenticity.

  • No deployable data is provided.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

No Sample Response

This method does not specify any sample responses.

Deploy Application License Configuration

Deploys a license configuration for an application.

POST /runtimes/mfp/license
Request

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. Allowed values true and false. By default, transactions are processed in synchronous mode.

  • The locale used for error messages.

Response

Status Code

  • The metadata of the deployable.

  • No deployable data is provided.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Get Application License Configuration

Retrieves the metadata of a specific license configuration for the application.

GET /runtimes/mfp/license/{application-name}
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The metadata of the deployable.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Delete Application License Configuration

Deletes a license configuration for the application name.

DELETE /runtimes/mfp/license/{application-name}
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

  • Whether the transaction is processed synchronously or asynchronously. Allowed values true and false. By default, transactions are processed in synchronous mode.

Response

Status Code

  • The metadata of the deleted license configuration.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Get Audit

GET /audit
Request

Query Parameters

  • Specify from which date audit log is required.

  • Specify till which date audit log is required.

Response

Status Code

  • The audit log for the specified date range.

  • Invalid payload.

  • An internal error occurred.

No Sample Response

This method does not specify any sample responses.

Get Confidential Clients

Retrieve the list of confidential clients

GET /runtimes/mfp/confidentialclients
Request

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The list of confidential clients for the given runtime.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found.

  • An internal error occurred.

Example responses

Update Confidential Clients

Sets the confidential clients list of a specific runtime.

PUT /runtimes/mfp/confidentialclients
Request

Query Parameters

  • The locale used for error messages.

  • Whether the transaction is processed synchronously or asynchronously. Allowed values are true and false. The default is synchronous processing.

Response

Status Code

  • The list of confidential clients for the given runtime.

  • The payload is invalid.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found.

  • An internal error occurred.

Example responses

Get Runtimes

Retrieves metadata for the list of runtimes.

GET /runtimes
Request

Query Parameters

  • The default mode running retrieves only the running runtimes, while the mode db retrieves also the runtimes stored in the database that might not be running.

  • The locale used for error messages.

Response

Status Code

  • The list of runtimes.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found.

  • An internal error occurred.

Example responses

Get Runtime

Retrieve metadata for the runtime.

GET /runtimes/mfp
Request

Query Parameters

  • Set to true to show details of the applications and adapters. The default is false.

  • The locale used for error messages.

Response

Status Code

  • The metadata for the runtime.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found.

  • An internal error occurred.

Example responses

Delete Runtime

DELETE /runtimes/mfp
Request

Query Parameters

  • Whether to delete the runtime only if it has no applications or adapters. Possible values are empty (delete only when empty) and always (delete even when not empty, the default).

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Get Runtime Lock

Retrieves information about the transaction lock of a runtime.

GET /runtimes/mfp/lock
Request

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • Indicates if the runtime is currently busy with a transaction.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found.

  • An internal error occurred.

Example responses

Delete Runtime Lock

Forces the release of the transaction lock of a runtime. This API should not be used in normal operations. Transactions are performed sequentually. Hence each transaction such as deploying an application or adapter takes the runtime lock. The next transaction waits until the lock is released. After a serious crash, it may happen that the lock is still taken even though the corresponding transaction crashed. The lock will get automatically released after 30 minutes. However, with this API, you can force the release of the lock earlier. Forcing the release of the lock when a transaction is currently active may corrupt the system. You should use this API only when you are sure that no transaction is currently active.

DELETE /runtimes/mfp/lock
Request

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • Indicates if the runtime is still busy with a transaction after forcing the release of the lock.

  • The user is not authorized to call this service.

  • An internal error occurred.

Example responses

Get Runtime Configuration

Retrieves the user configuration of a specific runtime.

GET /runtimes/mfp/config
Request

Query Parameters

  • If true (default), the configuration is a flat list of properties, otherwise a hierarchy of objects.

  • The locale used for error messages.

  • If no mode is specified, it returns the current user configuration. If the mode defaults is specified, it returns the default configuration.

Response

Status Code

  • The user configuration of the specified runtime.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found.

  • An internal error occurred.

Example responses

Update Runtime Configuration

Sets the user configuration of a specific runtime.

PUT /runtimes/mfp/config
Request

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. Allowed values are true and false. The default is synchronous processing.

  • The locale used for error messages.

Response

Status Code

  • The configuration of the specified runtime.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found.

  • An internal error occurred.

Example responses

Deploy

Deploy from a multipart compressed file

POST /runtimes/mfp/deploy/multi
Request

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed in synchronous mode.

  • The locale used for error messages.

Form Parameters

  • Deployable containing an adapter, application, license configuration, keystore, web resource, etc. (.json/.yaml).

Response

Status Code

  • The metadata of the deployable.

  • No deployable data is provided.

  • The user is not authorized to call this service.

  • The corresponding runtime is not found.

  • An internal error occurred.

Example responses

Register Application with Push Service

Creates a new server application for a push service. The applicationId is a unique identifier for this application. The application is a parent resource for devices, subscriptions, tags, and messages. The application must be created before it can access any of the child resources. If the application is deleted, all the children are deleted. The application holds the configurations, such as the Apple Push Notification Service (APNS) or Google Cloud Message (GCM) configuration, which is required by the push service to send messages. The API first creates the application and then sets the APNS and GCM credentials.

POST /runtimes/mfp/notifications/applications
Request

Query Parameters

  • The locale used for error messages.

Form Parameters

  • Whether the application is enabled or disabled.

  • The bundleId/PackageName/ProjectIdentityName of the application.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Create Tag

Creates a tag with a unique name in the application that is referenced by the applicationId parameter.

POST /runtimes/mfp/notifications/applications/{application-name}/tags
Request

Path Parameters

  • The name of the application.

Form Parameters

  • The description of the tag.

  • The name of the tag.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Get Tags

Retrieves all or a subset of tags in the application.

GET /runtimes/mfp/notifications/applications/{application-name}/tags
Request

Path Parameters

  • The name of the application.

Query Parameters

  • Retrieves additional metadata for every subscription that is returned in the response.

  • The filter specifies the search criteria. Refer to the filter section for the detailed syntax.

  • The locale used for error messages.

  • The pagination offset that is normally used in association with the size.

  • The pagination size that is normally used in association with the offset to retrieve a subset.

  • The pagination size that is normally used in association with the offset to retrieve a subset.

Response

Status Code

  • Retrieves tags of the application.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Delete Tag

Deletes the tag in the application.

DELETE /runtimes/mfp/notifications/applications/{application-name}/tags/{tag-name}
Request

Path Parameters

  • The name of the application.

  • The name of the tag.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Get Tag

Retrieves the specified tag in the application.

GET /runtimes/mfp/notifications/applications/{application-name}/tags/{tag-name}
Request

Path Parameters

  • The name of the application.

  • The name of the tag.

Response

Status Code

  • Retrieves details of a specific tag of the application.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Update Tag

Updates the tag that is idenfitied by the tagName parameter for the application referenced by the application name.

PUT /runtimes/mfp/notifications/applications/{application-name}/tags/{tag-name}
Request

Path Parameters

  • The name of the application.

  • The name of the tag.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Create Subscription

Create a new subscription for a tag

POST /runtimes/mfp/notifications/applications/{application-name}/subscriptions
Request

Path Parameters

  • The name of the application.

Query Parameters

  • When set to delete, this parameter unsubscribes a device from the list of tags that is specified in the tagNames field of the JSON body.

  • The locale used for error messages.

Form Parameters

  • The unique identifier of the device.

  • The tag name to subscribe.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Get Push Device Subscription

GET /runtimes/mfp/notifications/applications/{application-name}/subscriptions
Request

Path Parameters

  • The name of the application.

Query Parameters

  • Retrieves subscriptions only for the specified device.

  • The locale used for error messages.

  • Retrieves additional metadata for every subscription that is returned in the response.

  • The filter specifies the search criteria. Refer to the filter section for the detailed syntax.

  • The pagination offset that is normally used in association with the page size.

  • The pagination size that is normally used in association with the offset to retrieve a subset.

  • Retrieves subscriptions only for the specified tag.

  • Retrives subscriptions only for the specified user.

Response

Status Code

  • Retrieves all push subscriptions for the application.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • Unsupported Accept type - The content type specified in Accept header is not application/json.

  • An internal error occurred.

Example responses

Remove Subscription

Unsubscribes the specified device from a tag.

DELETE /runtimes/mfp/notifications/applications/{application-name}/subscriptions
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

  • The unique ID for the device.

  • The name of the tag to unsubscribe from.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Delete APNs settings

Deletes the APNs settings to the application referenced by the application name.

DELETE /runtimes/mfp/notifications/applications/{application-name}/apnsConf
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Get APNs Settings

Retrieves APNs credentials for the application.

GET /runtimes/mfp/notifications/applications/{application-name}/apnsConf
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The metadata of the APNS certificate.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Update APNs Settings

Uploads an APNs certificate to the application referenced by the application name.

PUT /runtimes/mfp/notifications/applications/{application-name}/apnsConf
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Delete GCM settings

Deletes the GCM settings to the application referenced by the application name.

DELETE /runtimes/mfp/notifications/applications/{application-name}/gcmConf
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Get GCM Settings

Retrieves GCM credentials for the application.

GET /runtimes/mfp/notifications/applications/{application-name}/gcmConf
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The metadata of the GCM credentials.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Update GCM Settings

Uploads a GCM certificate to the application referenced by the application name.

PUT /runtimes/mfp/notifications/applications/{application-name}/gcmConf
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Delete Message

Deletes a message identified by the messageId parameter.

DELETE /runtimes/mfp/notifications/applications/{application-name}/messages/{message-id}
Request

Path Parameters

  • The name of the application.

  • The message id of push message in push server.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Get Message

Retrieves information about a message identified by its messageId parameter.

GET /runtimes/mfp/notifications/applications/{application-name}/messages/{message-id}
Request

Path Parameters

  • The name of the application.

  • The message id of push message in push server.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The message details.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Send Bulk Messages

Send bulk messages by specifying various options.

POST /runtimes/mfp/notifications/applications/{application-name}/messages/bulk
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Send Message

Sends message with different options.

POST /runtimes/mfp/notifications/applications/{application-name}/messages
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Delete Subscription

Unsubscribes the device from the tag by using the subscription identifier. This method deletes neither the device registration nor the tag.

DELETE /runtimes/mfp/notifications/applications/{application-name}/subscriptions/{subscription-id}
Request

Path Parameters

  • The name of the application.

  • The subscription id of the application register with Push.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Retrieve Subscription to Push Service

The subscription referenced by the subscription identifier is retrieved.

GET /runtimes/mfp/notifications/applications/{application-name}/subscriptions/{subscription-id}
Request

Path Parameters

  • The name of the application.

  • The subscription id of the application register with Push.

Response

Status Code

  • Retrieves all push subscriptions for the application.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Delete WNS Settings

Deletes the WNS settings from the application referenced by the application name.

DELETE /runtimes/mfp/notifications/applications/{application-name}/wnsConf
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Get WNS Settings

Retrieves WNS credentials for the application.

GET /runtimes/mfp/notifications/applications/{application-name}/wnsConf
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The metadata of the WNS certificate.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Update WNS Settings

Uploads an WNS certificate to the application referenced by the application name.

PUT /runtimes/mfp/notifications/applications/{application-name}/wnsConf
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Get Push App Settings

Retrieves App Setting for the application registered with Push.

GET /runtimes/mfp/notifications/applications/{application-name}/settings
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • The metadata of the App settings.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Delete Push Device Registration

Deletes(unregisters) an existing device registration from the push service.

DELETE /runtimes/mfp/notifications/applications/{application-name}/devices/{device-id}
Request

Path Parameters

  • The name of the application.

  • The device Id.

Query Parameters

  • The locale used for error messages.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Retrieve Device Registration

Retrieves an existing device registration to the push service.

GET /runtimes/mfp/notifications/applications/{application-name}/devices/{device-id}
Request

Path Parameters

  • The name of the application.

  • The device Id.

Query Parameters

  • The locale used for error messages.

Response

Status Code

  • Retrieves an existing device registration of push.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • Unsupported Accept type - The content type specified in Accept header is not application/json.

  • An internal error occurred.

Example responses

Update Device Registration

Updates push device registration with the new user ID or the specified token. In most use cases, only the user ID is updated.

PUT /runtimes/mfp/notifications/applications/{application-name}/devices/{device-id}
Request

Path Parameters

  • The name of the application.

  • The device Id.

Query Parameters

  • The locale used for error messages.

  • Participate in the broadcast messaging.

Response

Status Code

No Sample Response

This method does not specify any sample responses.

Get Push Device Registration

Retrieves all or a subset of existing device registrations to the push service.

GET /runtimes/mfp/notifications/applications/{application-name}/devices
Request

Path Parameters

  • The name of the application.

Query Parameters

  • The user identifier of the device.

  • Whether an expanded version of the result should be shown. If this parameter is set to false, only a flat list of applications are returned. If the parameter is set to true, the entire hierarchy of environment and versions is returned, too.

    Example: true

  • The locale used for error messages.

    Example: en-US

  • From where to start listing entries, depending on the value of the size parameter.

  • The maximum number of entries to be listed per page. For example, 10.

  • The search criteria.

Response

Status Code

  • The metadata of the App settings.

  • The request was not understood by the push server.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • Unsupported Accept type - The content type specified in Accept header is not application/json.

  • An internal error occurred.

Example responses

Update Device Application Status

Changes the status of a specific application on a specific device.

PUT /runtimes/mfp/devices/{device-id}/applications/{application-name}
Request

Path Parameters

  • The name of the application.

  • The device id.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed synchronously.

  • The locale used for error messages.

Response

Status Code

  • The metadata of the transaction.

  • The payload is invalid.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Delete Device

Deletes all metadata of a specific device.

DELETE /runtimes/mfp/devices/{device-id}
Request

Path Parameters

  • The device id.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed synchronously.

  • The locale used for error messages.

Response

Status Code

  • The metadata of the deleted device.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Update Device Status

A device can be marked as active, lost, stolen, disabled, or expired. Lost, stolen, or disabled devices cannot access the server. A device is marked expired if it has not connected to the MobileFirst server for 90 days.

PUT /runtimes/mfp/devices/{device-id}
Request

Path Parameters

  • The device id.

Query Parameters

  • Whether the transaction is processed synchronously or asynchronously. The allowed values are true and false. By default, transactions are processed synchronously.

  • The locale used for error messages.

Response

Status Code

  • The metadata of the transaction.

  • The payload is invalid.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses

Get Devices

Retrieves metadata for the list of devices that accessed this project.

GET /runtimes/mfp/devices
Request

Query Parameters

  • The bookmark for the page if only a part of the list (a page) should be returned.

  • The locale used for error messages.

  • The sort mode. By default, the elements are sorted in increasing order. If the sort mode starts with - (minus sign), the elements are sorted in decreasing order. Possible sort modes are uid, friendlyName, deviceModel, deviceEnvironment, status, lastAccessed. The default sort mode is uid.

  • The number of elements if only a part of the list (a page) should be returned. The default value is 100.

  • A device-friendly name or a user to search for.

Response

Status Code

  • The metadata of the devices that accessed this project.

  • The user is not authorized to call this service.

  • The corresponding runtime or the application version is not found.

  • An internal error occurred.

Example responses