endpoint

Retrieve data quota details

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

Endpoint.Quota.Data + Get

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info>

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)
  • 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
get/api/v1/endpoint/{endpoint_id}/quota/data

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/endpoint/{endpoint_id}/quota/data
  • Auth: HTTP bearer

Path parameters

endpoint_idinteger required

Numeric ID of an endpoint

Response

Success

last_volume_addedstring
last_status_change_datestring
auto_refillinteger
threshold_volumestring
threshold_percentagestring
volumestring required
expiry_datestring required

Changes

No recorded changes to this operation across all 1 revision of this API.