serviceProfiles

Add data limit to service profile

<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>

ServiceProfile.TrafficLimit + Create

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

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.

<Note> Only users with `User` or `Admin` roles can use this API endpoint. Adding a data limit that already exists returns a `409` error. </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.

post/api/v1/service_profile/{profile_id}/traffic_limit

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/service_profile/{profile_id}/traffic_limit
  • Auth: HTTP bearer

Path parameters

profile_idnumber double required

The Numeric ID of a Service Profile

Request body

satellite_onlyboolean required

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.

volumeinteger required

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.

warning_percentinteger

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

ServiceProfilesAddServiceProfileTrafficLimitResponse201 required

Empty response body

Changes

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