Skip to content

application_objects

Overview

API to add, delete, get, modify global application objects

Version information

Version : v2

URI scheme

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

Tags

  • application_objects : Operations related to application_objects

Paths

POST operation for application_objects

POST /application_objects

Description

Use this operation to add global application objects

Parameters

Type Name Schema
Body body
optional
application_objects_request_schema

Responses

HTTP Code Description Schema
200 Resource successfully added application_objects_post_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

  • application_objects

Get operation for application_objects

GET /application_objects

Description

Use this operation to get the global application objects

Responses

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

  • application_objects

PUT operation for application_objects

PUT /application_objects

Description

Use this operation to modify global application objects

Responses

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

Produces

  • application/json

Tags

  • application_objects

DELETE operation for application_objects

DELETE /application_objects/{deletePathParam}

Description

Use this operation to delete global application objects

Parameters

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

Responses

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

  • application_objects

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

application_match_criteria

The Application Match Criteria

Type : < application_match_criteria > array

application_match_criteria

Name Description Schema
application
optional
Match Type for the application groups string
application_family
optional
Match Type for the application groups. The inputs are case sensitive enum (Antivirus, Application Service Service, Audio/Video/Video, Authentication, Behavioral, Citrix Protocol Protocol, Compression, Database, ERP, Encrypted, File Server Server, File Transfer Transfer, Forum, Game, Instant Messaging Messaging, Mail, Microsoft Office Office, Middleware, Network Management Management, Network Service Service, Peer to Peer to Peer, Printer, Routing, Security Service Service, Standard, Telephony, Terminal, Thin Client Client, Tunneling, Wap, Web, Webmail)
dscp
optional
Match IP DSCP tag enum (any, af11, af12, af13, af21, af22, af23, af31, af32, af33, af41, af42, af43, cs1, cs2, cs3, cs4, cs5, cs6, cs7, default, ef)
id
optional
Auto-generated ID to uniquely identify the application match criteria integer
match_type
optional
Match Type for the application groups enum (application_family, application, ip_protocol)
network_ip_address1
optional
Match source or destination IP address string
port1
optional
Match on either source or destination port number. Or specify a port range string
protocol
optional
Match on IP Protocol. Should be a numeric protocol number from 0 to 254 or ANY in case of all protocols string

application_objects

Name Schema
application_match_criteria
optional
application_match_criteria
id
optional
id
name
optional
name
package_name
optional
package_name
priority
optional
priority
properties
optional
properties

application_objects_delete_success_schema

Name Schema
application_objects
optional
application_objects

application_objects

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

application_objects_post_success_schema

Name Schema
application_objects
optional
application_objects

application_objects

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

application_objects_put_success_schema

Name Schema
application_objects
optional
application_objects

application_objects

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

application_objects_request_schema

Name Schema
application_objects
optional
application_objects

application_objects_response_schema

Type : < application_objects_response_schema > array

application_objects_response_schema

Name Schema
application_match_criteria
optional
application_match_criteria
id
optional
id
name
optional
name
package_name
optional
package_name
priority
optional
priority
properties
optional
properties

id

Auto-generated ID to uniquely identify application object

Type : integer

name

The name for the application object

Type : string

package_name

Config package name using which the API operation should be performed.

Type : string

priority

The order/precedence in which Applications are chosen for reporting (automatically redistributed)

Type : integer

properties

Properties for the autopath group

Name Description Schema
enable_reporting
optional
If this application is set to false, then the statistics will not be recorded boolean