Skip to navigation
Service ProfilesAdd a data limit to a service profile

Add a data limit to a service profile

Required permissions Beta Learn more

ServiceProfile.TrafficLimit + Create

Roles: Administrator User

Adds a data limit to a service profile. A data limit defines how much data each device with this service profile can use in a period. Use data limits to manage data usage and avoid overage charges.

In the request, set the service type, period, volume, and warning percentage.

Only users with the User or Administrator role can use this endpoint. Adding a data limit that already exists returns a 409 error.

To change a data limit, delete it and add a new one. The exception is a temporary traffic limit extension, which you can create without deleting the data limit.

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

profile_iddoubleRequired
Numeric ID of the service profile.

Request

This endpoint expects an object.
serviceobjectRequired

Service type to which the limit applies. The only supported service type is Data, which has an ID of 38.

satellite_onlybooleanRequired

Which data traffic the limit counts. This field is required, even if your devices don’t use satellite connectivity. If you’re unsure which value to use, set it to false.

  • false: the limit counts data over all radio access technology (RAT) types. Use this for most data limits.
  • true: the limit only counts data over satellite RAT types. Satellite data costs more than other data, so use this to set a separate limit for it.

A service profile can have one data limit with false and one with true for each service.

periodobjectRequired

Period of the limit. The only supported period is Monthly, which uses calendar months and has an ID of 2. The limit resets at 00:00 UTC on the first day of each month.

volumelongRequired1-9007199254740990
Limit threshold in the atomic units of the service type, which is bytes for data. It's the amount of data each device can use in each period before it reaches the limit.
warning_percentintegerOptional1-100

Percentage of the limit volume at which the system sends an Endpoint data traffic limit warning event (event type 65, see Event type object). For example, if you set it to 80, the system sends the event when a device has used 80% of the limit volume.

Response

The API created the data limit. The response contains the new data limit.
iddouble
ID of the data limit.
serviceobject
Service type to which the limit applies.
satellite_onlyboolean

Which data traffic the limit counts. If false, the limit counts data over all radio access technology (RAT) types. If true, it only counts data over satellite RAT types. Satellite data costs more than other data.

periodobject
Period of the limit.
volumelong1-9007199254740990
Limit threshold in the atomic units of the service type, which is bytes for data.
warning_percentintegerOptional1-100

Percentage of the limit volume at which the system sends an Endpoint data traffic limit warning event (event type 65, see Event type object). Only present if the data limit has a warning percentage.

Errors

400
Bad Request Error
403
Forbidden Error
409
Conflict Error