Skip to navigation
EndpointRetrieve data quota details

Retrieve data quota details

Returns the data quota of an endpoint, including its status and the remaining volume in MB.

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_idintegerRequired
Numeric ID of an endpoint

Response

Success
statusobject
Current status of the quota.
volumefloat
Remaining volume, in MB for a data quota or as a number of SMS for an SMS quota.
expiry_datestringformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"

When the quota expires, as YYYY-MM-DD HH:MM:SS in UTC. After this time, a device with a data quota can’t use data services, even if volume remains.

action_on_exhaustionobject
What happens when the quota volume runs out.
last_volume_addedfloatOptional
Volume from the most recent request that set the quota.
last_status_change_datestring or nullOptionalformat: "^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$"

When the quota was last set or its status last changed, as YYYY-MM-DD HH:MM:SS in UTC.

auto_refillenumOptional

Whether the quota refills daily with the last added volume. 0 means disabled and 1 means enabled.

Allowed values:
threshold_percentageintegerOptional
Percentage of the volume below which the system generates a threshold event.
threshold_volumefloatOptional

Remaining volume at which the system generates a threshold event, calculated from volume and threshold_percentage when a request sets threshold_percentage.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error