Skip to content

apn_settings

Overview

API to update the Mobile Broadband APN Settings

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/mobile_broadband/
Schemes : HTTP

Tags

  • apn_settings : Operations related to apn_settings

Paths

Get operation for apn_settings

GET /apn_settings

Description

Use this operation to get the Mobile Broadband APN Settings from SD-WAN Appliance

Responses

HTTP Code Description Schema
200 API Successfully executed apn_settings_response_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Produces

  • application/json

Tags

  • apn_settings

PUT operation for apn_settings

PUT /apn_settings

Description

Use this operation to update the Mobile Broadband APN Settings in SD-WAN Appliance

Parameters

Type Name Schema
Body body
optional
apn_settings_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added apn_settings_put_success_schema
400 Failed: bad input parameter ErrorSchema
401 Unauthorized: Failed Authentication ErrorSchema
403 Unauthorized: Forbidden ErrorSchema
405 Failed: Data format unacceptable ErrorSchema
415 Failed: Data format unacceptable ErrorSchema
500 Failed: Internal Server Error ErrorSchema

Consumes

  • application/json

Produces

  • application/json

Tags

  • apn_settings

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

apn

Name of the Access Point

Type : string

apn_settings

Name Schema
apn
optional
apn
authentication
optional
authentication
password
optional
password
username
optional
username

apn_settings_delete_success_schema

Name Schema
apn_settings
optional
apn_settings

apn_settings

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

apn_settings_post_success_schema

Name Schema
apn_settings
optional
apn_settings

apn_settings

Name Description Schema
message
optional
Example : "resource added succesfully" string

apn_settings_put_success_schema

Name Schema
apn_settings
optional
apn_settings

apn_settings

Name Description Schema
message
optional
Example : "resource modified succesfully" string

apn_settings_request_schema

Name Schema
apn_settings
optional
apn_settings

apn_settings_response_schema

Type : < apn_settings_response_schema > array

apn_settings_response_schema

Name Schema
apn
optional
apn
authentication
optional
authentication
password
optional
password
username
optional
username

authentication

Authentication for APN. Expected authentications are None, PAP, CHAP and PAPCHAP.

Type : enum (None, PAP, CHAP, PAPCHAP)

password

Authentication Password for APN.

Type : string

username

User Name for APN. Valid characters are alphabets, digits, underscore(_) and hyphen(-) and it should start with an alphabet.

Type : string