Change APN for dongles

POST

{{BASE_URL}}/v2/change_apn

Updates the APN configuration for one or more dongles.
This operation is supported for XProxy XH20/XH22 dongles model only.

Request

Body Params application/json

positions

array[integer]

required

Array of position indexes to change APN for

Example:

[1,2,3]

apn

object

required

auto_apn

string

required

APN mode setting:

1 = AUTO (automatically detect and set APN)

0 = MANUAL (use provided APN settings)

Example:

apn_name

string

optional

APN name (required when auto_apn=0)

Example:

internet

ip_type

string

optional

IP type (required when auto_apn=0):

0 = IPv4/IPv6 dual stack

1 = IPv4 only

2 = IPv6 only

Example:

auth_type

string

optional

Authentication type (required when auto_apn=0):

NONE = No authentication

PAP = PAP authentication

CHAP = CHAP authentication

Example:

NONE

auth_user

string

optional

Authentication username (required if auth_type is not NONE)

Example:

user

auth_pass

string

optional

Authentication password (required if auth_type is not NONE)

Example:

password

Example

{
    "positions": [
        1,
        2,
        3
    ],
    "apn": {
        "auto_apn": "0",
        "apn_name": "internet",
        "ip_type": "0",
        "auth_type": "NONE",
        "auth_user": "user",
        "auth_pass": "password"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://localhost/v2/change_apn' \
--header 'Content-Type: application/json' \
--data-raw '{
    "positions": [
        1,
        2,
        3
    ],
    "apn": {
        "auto_apn": "0",
        "apn_name": "internet",
        "ip_type": "0",
        "auth_type": "NONE",
        "auth_user": "user",
        "auth_pass": "password"
    }
}'

Responses

🟢200OK

application/json

Successful operation

Body

status

boolean

optional

Example:

true

msg

string

optional

Example:

Sent change APN successfully! Please wait up to 15s to effect!

Example

{
    "status": true,
    "msg": "Sent change APN successfully! Please wait up to 15s to effect!"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2025-04-23 02:54:18

Change MAC address for dongles

Change device label