Supported Request Methods

SonicOS API utilizes four of the methods defined in the HTTP protocol (RFC 7231 and RFC 5789) to create, read, update and delete (CRUD) resources. Supported HTTP request methods describes the supported HTTP methods for management operations after authentication. Refer to Client Authentication for the methods supported during authentication.

Supported HTTP request methods

HTTP method	Description
GET	Retrieves the specified resource or collection of resources. GET is a read-only operation that does not alter appliance state or configuration. A GET operation should not contain a request-body.
POST	Submits data to be processed by the specified resource or collection of resources. In most cases, the POST verb is used by SonicOS APIs to create and add a resource to a collection of resources (for example, add a new MAC address-object to collection of objects).
PUT	Updates the specified resource. The data included in the PUT request-body replaces the previous configuration.
DELETE	Deletes the specified resource or collection of resources.

Supported HTTP header request and response formats

Type	Example
Text/plain	GET /api/sonicos/address-objects/mac Accept: text/plain
Application/JSON	POST /api/sonicos/address-objects/mac Content-type: application/json Accept: application/json { "address_object": { "mac": { "name": "001122334455" ,"address": "001122334455" ,"multi_homed": true ,"zone": "LAN" } } }

To configure all other parameters

config(C0EAE483FB86)# administration

(config-administration)# sonicos-api

(config-sonicos-api)# exit

(config-administration)# commit

SonicOS API Commands
basic	chap
digest	hold-password
integrity-protection	max-nonce
md5-digest	public-key
rsa-key-size	rsa-padding-type
session-security	sha256-digest
two-factor-bearer-token