EnterpriseService Profiles

Add data limit to service profile

This API endpoint allows you to add a data limit to a service profile. A data limit is a rule that defines how much data a service can consume within a certain period. This is useful for managing your data usage and avoiding overage charges. You can use this API to customize the data limit for your service profile by specifying the service type, time period, volume threshold, and warning percentage. You can also choose to apply the data limit only to satellite radio access technology (RAT) types that use satellites for communication. <Note> Only users with `User` or `Admin` roles can use this API endpoint. You can only add **one** data limit per service and satellite RAT type combination. </Note> To change the data limit, you must first delete the existing data limit and then add a new one. **Exception**: Creating a temporary [traffic limit extension](/developers/emnify-rest-api/enterprise/endpoint/create-endpoint-traffic-limit-extension).

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_idstringRequired

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.

volumelongRequired

Limit threshold in the atomic units of the service type (for data, this is bytes). This specifies the amount of data that the service can consume within the period before the limit is reached or exceeded.

satellite_onlybooleanOptionalDefaults to false

Determines if the limit only applies to satellite RAT types. The default value is false, which means the limit applies to all RAT types.

periodobjectOptional

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

warning_percentintegerOptional0-100

Percentage of the limit volume when the system sends an event. The event is sent when the limit is reached or exceeded. For example, if you set the warning percentage to 80, the system sends an event when the service consumes 80% of the limit volume.

Response

Created

Errors