Update APN Profile (v2.0)

PUT 
/sdwan/v2.0/api/apnprofiles/:apnprofile_id

Update an APN Profile.

Request

Path Parameters

apnprofile_id stringrequired

The ID of the APN profile.

application/json

Body

apn string

Enter the APN name that provides access to the mobile broadband network. APN information is provided by the operator. APN name must be greater than one character and an allowed max length is 100. Valid characters are alphanumeric, hyphen (-), and period (.). Must begin and end with an alphanumeric character.

authentication stringrequired

Possible values: [none, pap, chap, pap_or_chap]

Authentication mode to access the mobile broadband network.

clear_password boolean

Ignore this field.

description

Enter the name or acronym of the mobile broadband service provider or any other information that might help you to identify the APN profile. Max size = 256.

id string

Ignore this field.

name stringrequired

Enter the name or acronym to identify the APN profile. Max size = 128.

password string

If you select an authentication mode, enter the password to access the mobile broadband network.

tags string[]

Tags is a mechanism to group the content for easy retrieval. It helps to organize the content. The tags associate a relevance to the object.

user_name string

If you select an authentication mode, enter the user name to access the mobile broadband network. Size (max = 100, min = 0).

Responses

200

Successful Operation

application/json

Schema

Schema

apn string

Enter the APN name that provides access to the mobile broadband network. APN information is provided by the operator. APN name must be greater than one character and an allowed max length is 100. Valid characters are alphanumeric, hyphen (-), and period (.). Must begin and end with an alphanumeric character.

authentication stringrequired

Possible values: [none, pap, chap, pap_or_chap]

Authentication mode to access the mobile broadband network.

clear_password boolean

Ignore this field.

description

Enter the name or acronym of the mobile broadband service provider or any other information that might help you to identify the APN profile. Max size = 256.

id string

Ignore this field.

name stringrequired

Enter the name or acronym to identify the APN profile. Max size = 128.

password string

If you select an authentication mode, enter the password to access the mobile broadband network.

tags string[]

Tags is a mechanism to group the content for easy retrieval. It helps to organize the content. The tags associate a relevance to the object.

user_name string

If you select an authentication mode, enter the user name to access the mobile broadband network. Size (max = 100, min = 0).

Example (from schema)

{
  "apn": "string",
  "authentication": "none",
  "clear_password": true,
  "id": "string",
  "name": "string",
  "password": "string",
  "tags": [
    "string"
  ],
  "user_name": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON_INPUT"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      },
      {
        "code": "APN_PROFILE_MISSING_APN_NAME"
      },
      {
        "code": "APN_PROFILE_NAME_INVALID"
      },
      {
        "code": "APN_PROFILE_PASSWORD_INVALID"
      },
      {
        "code": "APN_PROFILE_USERNAME_INVALID"
      },
      {
        "code": "APN_PROFILE_INVALID_APN_AUTH"
      },
      {
        "code": "APN_PROFILE_PASSWORD_WITHOUT_USERNAME"
      },
      {
        "code": "APN_PROFILE_PASSWORD_PRESENT_WHEN_CLEAR_PASSWORD_TRUE"
      }
    ]
  }
}

Loading...