Skip to content

APN Globals⚓︎

Path⚓︎

/v1/apn-globals

An APN Global is where you define APN names for your subscriber fleet, and their associated default maximum upload and download values to be used in conjunction with APN Profiles and System Profiles.

Multiple APN Globals can be created if your SIM requires more than one APN.

 


Resource Attributes⚓︎

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

Attribute Type Required? Description
name String YES The name of the apn global.
upload Integer YES The maximum upload bitrate in bits per second.
download Integer YES The maximum download bitrate in bits per second.
apnQos String NO The default QoS/QCI associated with this APN.

Example⚓︎

{
  "name": "internet",
  "upload": 210000000,
  "download": 310000000,
  "apnQos": "{baseUrl}/v1/apn-qos/8"
}

 


Endpoints⚓︎

Request Examples⚓︎

Get a list of all apn globals ::⚓︎

{baseUrl}/v1/apn-globals

Get a specific apn global ::⚓︎

{baseUrl}/v1/apn-globals/

The <apnGlobalID> is discovered by selecting or searching for an apn-global.

Get search for an apn global. You can use findByDeepSearch to find specific apn global ID::⚓︎

{baseUrl}/v1/apn-globals/search/findByDeepSearch?searchString=<searchCriteria>