Update Cellular Modules Sim Security (v2.0)

PUT 
/sdwan/v2.0/api/elements/:element_id/cellular_modules/:cellular_module_id/sim_security/:sim_security_id

Update the cellular modules sim security information.

Request

Path Parameters

element_id stringrequired

ID of the element.

cellular_module_id stringrequired

ID of the cellular module.

sim_security_id stringrequired

ID of the sim security.

application/json

Body

description

The description of the sim security. Max size = 256.

id string

The ID of the sim security.

name stringrequired

The name of the sim security. Max size = 128.urce name.

pin string

The pin of the sim security. Pin must be numeric with minimum 4 and maximum 8 digits.

remove_pin booleanrequired

The remove pin of the sim security.

slot_number int32required

The slot number of the sim.

tags string[]

An information field that can be added to identify the sim security. Maximum 10 unique tags of length 1024 each are allowed.

Responses

200

Successful Operation

application/json

Schema

Schema

description

The description of the sim security. Max size = 256.

id string

The ID of the sim security.

name stringrequired

The name of the sim security. Max size = 128.

pin string

The pin of the sim security. Pin must be numeric with minimum 4 and maximum 8 digits.

remove_pin booleanrequired

The remove pin of the sim security.

slot_number int32required

The slot number of the sim.

tags string[]

An information field that can be added to identify the sim security. Maximum 10 unique tags of length 1024 each are allowed.

Example (from schema)

{
  "id": "string",
  "name": "string",
  "pin": "string",
  "remove_pin": true,
  "slot_number": 0,
  "tags": [
    "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": "SIM_SECURITY_CONFIG_REMOVE_PIN_REQD"
      },
      {
        "code": "SIM_SECURITY_CONFIG_PIN_MUST_BE_EMPTY"
      },
      {
        "code": "SIM_SECURITY_CONFIG_MUST_HAVE_PIN"
      },
      {
        "code": "SIM_SECURITY_CONFIG_INVALID_PIN"
      },
      {
        "code": "SIM_SECURITY_PIN_STORAGE_FAILURE"
      },
      {
        "code": "SIM_SECURITY_CONFIG_UNSUPPORTED_DEVICESW"
      }
    ]
  }
}

Loading...