Skip to content

app_qoe_profile

Overview

API to add , delete, get, modify global application qoe profile

Version information

Version : v2

URI scheme

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

Tags

  • app_qoe_profile : Operations related to app_qoe_profile

Paths

POST operation for app_qoe_profile

POST /app_qoe_profile

Description

This operation is to add new application QoE profiles

Parameters

Type Name Schema
Body body
optional
app_qoe_profile_request_schema

Responses

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

  • app_qoe_profile

Get operation for app_qoe_profile

GET /app_qoe_profile

Description

This opertaion is to get the application QoE Profiles

Responses

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

  • app_qoe_profile

PUT operation for app_qoe_profile

PUT /app_qoe_profile

Description

This operation is to modify existing application QoE profiles

Responses

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

  • app_qoe_profile

DELETE operation for app_qoe_profile

DELETE /app_qoe_profile/{deletePathParam}

Description

This operation is to delete application QoE profiles except for the default profile which is auto created

Parameters

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

Responses

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

  • app_qoe_profile

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

app_qoe_profile

Name Schema
burst_rate
optional
burst_rate
id
optional
id
jitter
optional
jitter
latency
optional
latency
name
optional
name
package_name
optional
package_name
packet_loss
optional
packet_loss
packet_loss_per_flow
optional
packet_loss_per_flow

app_qoe_profile_delete_success_schema

Name Schema
app_qoe_profile
optional
app_qoe_profile

app_qoe_profile

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

app_qoe_profile_post_success_schema

Name Schema
app_qoe_profile
optional
app_qoe_profile

app_qoe_profile

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

app_qoe_profile_put_success_schema

Name Schema
app_qoe_profile
optional
app_qoe_profile

app_qoe_profile

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

app_qoe_profile_request_schema

Name Schema
app_qoe_profile
optional
app_qoe_profile

app_qoe_profile_response_schema

Type : < app_qoe_profile_response_schema > array

app_qoe_profile_response_schema

Name Schema
burst_rate
optional
burst_rate
id
optional
id
jitter
optional
jitter
latency
optional
latency
name
optional
name
package_name
optional
package_name
packet_loss
optional
packet_loss
packet_loss_per_flow
optional
packet_loss_per_flow

burst_rate

Burst rate

Type : number

id

Auto-generated ID to uniquely identify application qoe profile

Type : integer

jitter

Jitter in ms

Type : integer

latency

Latency in ms

Type : integer

name

Name of the application qoe profile

Type : string

package_name

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

Type : string

packet_loss

Packet loss(%)

Type : number

packet_loss_per_flow

Packet loss per flow for interactive traffic(%)

Type : number