Skip to content

firmware

Overview

API to get all firmwares available in the Mobile Broadband device

Version information

Version : v2

URI scheme

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

Tags

  • firmware : Operations related to firmware

Paths

Get operation for firmware

GET /firmware

Description

Use this operation to get the list of Mobile Broadband Firmware

Responses

HTTP Code Description Schema
200 API Successfully executed firmware_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

  • firmware

PUT operation for firmware

PUT /firmware

Description

Use this operation to update the Firmware in Mobile Broadband Device

Parameters

Type Name Schema
Body body
optional
firmware_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added firmware_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

  • firmware

DELETE operation for firmware

DELETE /firmware/{deletePathParam}

Description

Use this operation to delete the Firmware in Mobile Broadband Device

Parameters

Type Name Description Schema
Path deletePathParam
required
Object Primary Key for DELETE operation object

Responses

HTTP Code Description Schema
200 Resource delete added firmware_delete_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

Produces

  • application/json

Tags

  • firmware

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

firmware

Name Schema
firmware_name
optional
firmware_name

firmware_delete_success_schema

Name Schema
firmware
optional
firmware

firmware

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

firmware_name

Name of the firmware. Valid characters are alphabets, digits, underscore(_), hyphen(-) and dot(.).

Type : string

firmware_post_success_schema

Name Schema
firmware
optional
firmware

firmware

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

firmware_put_success_schema

Name Schema
firmware
optional
firmware

firmware

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

firmware_request_schema

Name Schema
firmware
optional
firmware

firmware_response_schema

Type : < firmware_response_schema > array

firmware_response_schema

Name Schema
firmware_name
optional
firmware_name