Skip to content

APN Profiles⚓︎

Path⚓︎

/v1/apn-profiles

An APN Profile is used to associate an APN Global to a System Profile in an ordered list. An APN Profile includes an APN from the available APN Globals, and specifies an optional maximum download and upload bitrate, where the maximum download and upload bitrate defined in the APN Profile can override the values defined in the APN Global.

If a System Profile needs to support multiple APNs, you must define multiple APN Profiles in an ordered list in the System Profile. The ordering attribute shows in which (0 indexed) order the APN Profile is in the list within the System Profile.

 

Resource Attributes⚓︎

The attributes for the sub-profiles resource are detailed below:

Attribute Type Required? Description
ordering Integer YES The index order of the APN in the APN list.
upload Integer NO The maximum upload bitrate in bits per second.
download Integer NO The maximum download bitrate in bits per second.
apnQos String NO The QoS profile to apply, overriding the APN Global default.
apnOverrides Set NO A set of carrier-specific QoS and bitrate overrides.

Example⚓︎

{
  "ordering": 0,
  "upload": 20971520,
  "download": 31457280,
  "apnQos": "{baseUrl}/v1/apn-qos/1",
  "apnOverrides": [
    {
      "carrier": "{baseUrl}/v1/carriers/123",
      "apnQos": "{baseUrl}/v1/apn-qos/456",
      "download": 10485760,
      "upload": 5242880
    }
  ]
}

 

Endpoints⚓︎

Request Examples⚓︎

Get a list of all apn profiles::⚓︎

{baseUrl}/v1/apn-profiles

Get a specific apn profile::⚓︎

{baseUrl}/v1/apn-profiles/<profileID>

Get a list of all apn globals assigned a specific apn profile::⚓︎

{baseUrl}/v1/apn-profiles/<profileID>/apnGlobal

Get a list of all system profiles assigned a specific apn profile::⚓︎

{baseUrl}/v1/apn-profiles/<profileID>/systemProfile

The <profileID> is discovered by selecting or searching for all apn profiles.