How to set a data limit for a specific endpoint via API?

You are able to configure monthly data limits in the EUI, within the Service Profile configuration. Once the data limit is exceeded by an endpoint (which has that service profile assigned), the PDP Context is rejected and an alarm is displayed in the EUI. 

Important note: When quota management is enabled in the service profile, you must assign a quota to each endpoint that uses this service profile, otherwise these endpoints will be blocked in creating PDP because there's no defined quota. 

If you would like to define a data limit/quota, you can use the EMnify API Quota Management (you can also set an expiration date). It is also possible to define an action to be performed on the expiration date, i.e. the endpoint can be blocked for data services or merely see the connection throttled.

The daily limit will auto-refill everyday at midnight UTC until the expiry date is reached.

Using the API Quota Management

1. Create a quota 

POST https://cdn.emnify.net/api/v1/endpoint/{endpoint-Id}/quota/data

Header

• Content-Type: application/json
• Authorization: Bearer {{auth_token}}

Body

• Status
• id: 1, 2 or 3
• Description: Active, Exhausted or Expired
• Volume: Any, format e.g. 100.00 (MB)
• Auto Refill: True or false
• Expiry Date: Any, format - "yyyy-mm-ddThh:mm:ss+utc_offset"
• Action On Exhaustion
• id: 1 or 2
• Description: Block or Throttle 
• Peak Throughput: If throttle - 64000, 128000 or 256000 (bits per second)

Example (via Postman):

{
    "status": {
        "id": 1,
        "description": "ACTIVE"
    },
    "volume": 100.00,
    "expiry_date": "2017-05-19T08:00:00+0000",
    "auto_refill": true,
    "action_on_exhaustion": {
        "id": 2,
        "description": "Throttle",
        "peak_throughput": 128000
    }
}

2. Retrieve the quota status

GET https://cdn.emnify.net/api/v1/endpoint/{endpoint-Id}/quota/data

Example (via Postman):

{
    "volume": 10,
    "expiry_date": "2017-05-19 08:00:00",
    "peak_throughput": 128000,
    "last_volume_added": 100,
    "last_status_change_date": "2017-05-07 10:52:46",
    "auto_refill": true,
    "status": {
        "description": "ACTIVE",
        "id": 1
    },
    "action_on_exhaustion": {
        "action_on_quota_exhaustion_id": "2",
        "description": "Throttle",
        "id": 2
    }
}

3. View quota in the EUI

Once the quota has been set, the information is visible on the EUI under each endpoint using the configured service profile.