REST API Administration Services
The REST API provides several services to administer the runtime environments concerning adapters, applications, devices, audit, transactions, security, and push notifications.
The REST service API for adapters and applications for each runtime environment is located in /management-apis/1.0/runtimes/runtime-name/, where runtime-name is the name of the runtime environment 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/1.0/runtimes/runtime-name/Adapters (POST) refers to the service for deploying an adapter.
- Adapter Binary (GET, HEAD)
Retrieves the binary of a specific adapter. - Adapter (DELETE)
Deletes a specific adapter. - Adapter (GET)
Retrieves metadata of a specific adapter. - Adapter (POST)
Deploys an adapter. - Adapters (GET)
Retrieves metadata for the list of deployed adapters. - Adobe Air Application Binary (GET)
Retrieves the Adobe Air binary of a specific app version. - APNS Credentials (DELETE)
Deletes Apple Push Notification Service (APNS) credentials of the application with the application ID, environment, and version. - APNS Credentials (GET)
Retrieves Apple Push Notification Service (APNS) credentials of the application with the application ID, environment, and version. - APNS Credentials (PUT)
Sets Apple Push Notification Service (APNS) credentials of the application with the application ID, environment, version, password, certificate file name, and certificate. - App Version Access Rule (PUT)
Sets the access rule of a specific app version. - App Version (DELETE)
Deletes a specific app version. - App Version Lock (PUT)
Locks a specific app version. - Application Binary (GET, HEAD)
Retrieves the binary of a specific app version. - Application (DELETE)
Deletes a specific application and all its app versions. - Application (GET)
Retrieves metadata of a specific application. - Application (POST)
Deploys an application. - Applications (GET)
Retrieves metadata for the list of deployed applications. - Associate beacons and triggers (DELETE)
Deletes the association of beacons and triggers with the UUID, major number, minor number and triggerName. - Associate beacons and triggers (GET)
Retrieves the association of beacons and triggers with the UUID, major number, minor number, and triggerName. - Associate beacons and triggers (PUT)
Associates the specified beacons with the specified triggers. - Beacon Trigger (DELETE)
Deletes the beacon trigger by using the triggerName. - Beacon Trigger (GET)
Retrieves the beacon trigger with the triggerName. - Beacon Triggers (GET)
Retrieves all the beacon triggers. - Beacon Triggers (POST)
Adds a new beacon trigger by using the triggerName, triggerType, proximityState, and actionPayload properties. - Beacon Triggers (PUT)
Updates the beacon trigger that is specified by using the triggerName property. Other properties (triggerType, proximityState, dwellingTime, and actionPayload) are optional. Only those that need to be updated must be specified. - Beacons (DELETE)
Deletes the beacon by using the UUID, the major number, and minor number. - Beacons (GET)
Retrieves the beacon with the UUID, major number, and minor number. - Beacons (PUT)
Registers (Adds/Updates) the beacon that is identified by UUID, major number, and minor number in the payload. - Device Application Status (PUT)
Changes the status of a specific application on a specific device. - Device (DELETE)
Deletes all metadata of a specific device. - Device Status (PUT)
Changes the status of a specific device. - Devices (GET)
Retrieves metadata for the list of devices that accessed this project. - Event Source (GET)
Retrieves metadata for the event source. - Event Sources (GET)
Retrieves metadata for the list of event sources. - Farm topology members (GET)
Retrieves the list of members of the farm. - Farm topology members (DELETE)
Unregisters a farm node. - GCM Credentials (DELETE)
Deletes Google Cloud Messaging (GCM) credentials of the application with the application ID, environment, and version. - GCM Credentials (GET)
Retrieves Google Cloud Messaging (GCM) credentials of the application with the application ID, environment, and version. - GCM Credentials (PUT)
Set Google Cloud Messaging (GCM) credentials of the application with the application ID, environment, and version. - Mediator (GET)
Retrieves metadata of the mediator. - Mediators (GET)
Retrieves the list of all supported mediators for sending notifications. - MPNS Credentials (DELETE)
Deletes MPNS credentials of the application with the application ID, environment, and version. - MPNS Credentials (GET)
Retrieves MPNS credentials of the application with the application ID, environment, and version. - MPNS Credentials (PUT)
Set MPNS credentials of the application with the application ID, environment, version, keyAlias, keyAliasPassword, and serviceName. - Push Device Registration (DELETE)
Deletes the device with the device ID and application ID. - Push Device Registration (GET)
Retrieves metadata of the device with the given device ID. - Push Device Subscription (DELETE)
Delete subscriptions of a combination of application, tag name, and device ID. - Push Device Subscription (GET)
Retrieves metadata of the subscriptions. - Push Devices Registration (GET)
Retrieves metadata for the list of devices of an application. - Push Enabled Applications (GET)
Retrieves metadata for the list of deployed push enabled applications. - Push Tags (DELETE)
Deletes tag of the application with the application ID and tag. - Push Tags (GET)
Retrieves tags of the application with the application ID. - Push Tags (POST)
Create Tags of the application with the application ID. - Push Tags (PUT)
Update Tags of the application with the application ID and tag. - Runtime (DELETE)
Deletes a specific runtime. - Runtime (GET)
Retrieves metadata for a specific runtime. - Runtime Lock (DELETE)
Forces the release of the transaction lock of a runtime. - Runtime Lock (GET)
Retrieves information about the transaction lock of a runtime. - Runtimes (GET)
Retrieves metadata for the list of runtimes. - Send Bulk Messages (POST)
Send bulk messages with different options to be specified. - Send Message (POST)
Send message with different options to be specified. - Transaction (GET)
Retrieves information of a specific transaction. - Transactions (GET)
Retrieves information of failed transactions. - Unsubscribe SMS (POST)
Unsubscribes the list of given phone numbers for SMS. - WNS Credentials (DELETE)
Deletes Windows Push Notification Services (WNS) credentials of the application with the application ID, environment, and version. - WNS Credentials (GET)
Retrieves Windows Push Notification Services (WNS) credentials of the application with the application ID, environment, and version. - WNS Credentials (PUT)
Sets Windows Push Notification Services (WNS) credentials of the application with the application ID, environment, and version.
Parent topic: API reference