Retrieve data quota details | emnify Documentation

Returns details about the assigned Data Quota for an endpoint.

status: this indicates the current status of the quota and may contain the following values:
- ACTIVE: the endpoint can currently connect and has quota left
- EXHAUSTED: the endpoint has exceeded the quota volume, if it still can use data service depends on the action chosen to be performed on exhaustion
- EXPIRED: the quota has expired; the endpoint is denied from using data services (until new quota is added)
volume: returns the volume left on this quota in MB
expiry_date: timestamp when this quota will expire and the endpoint will definitely be denied from using further data services (regardless if the quota volume was used up or not)
peak_throughput: The maximum bandwidth in octets per second after the endpoint has been throttled.
action_on_exhaustion: returns the behaviour defined to be applied when quota volume is used up (exhausted).
- Throttle: bandwidth will be throttle to the defined peak throughput until quota expires
- Block: data service will be instantly blocked once volume used up, regardless if the expiry date is already reached or not
auto_refill: 0 (false) / 1 (true), refill the quota with the last added volume on a daily basis

Returns details about the assigned Data Quota for an endpoint. * `status`: this indicates the current status of the quota and may contain the following values: - `ACTIVE`: the endpoint can currently connect and has quota left - `EXHAUSTED`: the endpoint has exceeded the quota volume, if it still can use data service depends on the action chosen to be performed on exhaustion - `EXPIRED`: the quota has expired; the endpoint is denied from using data services (until new quota is added) * `volume`: returns the volume left on this quota in MB * `expiry_date`: timestamp when this quota will expire and the endpoint will definitely be denied from using further data services (regardless if the quota volume was used up or not) * `peak_throughput`: The maximum bandwidth in octets per second after the endpoint has been throttled. * `action_on_exhaustion`: returns the behaviour defined to be applied when quota volume is used up (exhausted). - `Throttle`: bandwidth will be throttle to the defined peak throughput until quota expires - `Block`: data service will be instantly blocked once volume used up, regardless if the expiry date is already reached or not * `auto_refill`: 0 (false) / 1 (true), refill the quota with the last added volume on a daily basis

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

endpoint_idstringRequired

Response

Success

statusobject

volumedouble

expiry_datestringformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"

action_on_exhaustionobject

last_volume_addeddouble or null

last_status_change_datestring or nullformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"

auto_refillinteger or null

threshold_volumedouble or null

threshold_percentagedouble or null

Returns details about the assigned Data Quota for an endpoint.

status: this indicates the current status of the quota and may contain the following values:
- ACTIVE: the endpoint can currently connect and has quota left
- EXHAUSTED: the endpoint has exceeded the quota volume, if it still can use data service depends on the action chosen to be performed on exhaustion
- EXPIRED: the quota has expired; the endpoint is denied from using data services (until new quota is added)
volume: returns the volume left on this quota in MB
expiry_date: timestamp when this quota will expire and the endpoint will definitely be denied from using further data services (regardless if the quota volume was used up or not)
peak_throughput: The maximum bandwidth in octets per second after the endpoint has been throttled.
action_on_exhaustion: returns the behaviour defined to be applied when quota volume is used up (exhausted).
- Throttle: bandwidth will be throttle to the defined peak throughput until quota expires
- Block: data service will be instantly blocked once volume used up, regardless if the expiry date is already reached or not
auto_refill: 0 (false) / 1 (true), refill the quota with the last added volume on a daily basis

1	import requests
2
3	url = "https://cdn.emnify.net/api/v1/endpoint/endpoint_id/quota/data"
4
5	headers = {"Authorization": "Bearer <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"status": {
3	"id": 1,
4	"description": "ACTIVE"
5	},
6	"volume": 99.999228,
7	"expiry_date": "2020-01-17T08:47:00.000Z",
8	"action_on_exhaustion": {
9	"id": 1,
10	"description": "Block",
11	"action_on_quota_exhaustion_id": "1"
12	},
13	"last_volume_added": 100,
14	"last_status_change_date": "2019-04-10 14:22:11",
15	"auto_refill": 0,
16	"threshold_volume": 15,
17	"threshold_percentage": 15,
18	"peak_throughput": 128000
19	}