Skip to content

service_provider

Overview

API to add, delete, get, modify service providers

Version information

Version : v2

URI scheme

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

Tags

  • service_provider : Operations related to service_provider

Paths

POST operation for service_provider

POST /service_provider

Description

Use this operation to add service providers

Parameters

Type Name Schema
Body body
optional
service_provider_request_schema

Responses

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

  • service_provider

Get operation for service_provider

GET /service_provider

Description

Use this operation to get the service providers

Responses

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

  • service_provider

PUT operation for service_provider

PUT /service_provider

Description

Use this operation to modify service providers

Responses

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

  • service_provider

DELETE operation for service_provider

DELETE /service_provider/{deletePathParam}

Description

Use this operation to delete service providers

Parameters

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

Responses

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

  • service_provider

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

id

Auto-generated ID to uniquely identify service providers

Type : integer

name

The name for the service provider

Type : string

package_name

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

Type : string

service_provider

Name Schema
id
optional
id
name
optional
name
package_name
optional
package_name
templates
optional
templates

service_provider_delete_success_schema

Name Schema
service_provider
optional
service_provider

service_provider

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

service_provider_post_success_schema

Name Schema
service_provider
optional
service_provider

service_provider

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

service_provider_put_success_schema

Name Schema
service_provider
optional
service_provider

service_provider

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

service_provider_request_schema

Name Schema
service_provider
optional
service_provider

service_provider_response_schema

Type : < service_provider_response_schema > array

service_provider_response_schema

Name Schema
id
optional
id
name
optional
name
package_name
optional
package_name
templates
optional
templates

templates

Templates for service providers

Type : < templates > array

templates

Name Description Schema
id
optional
Auto-generated ID to uniquely identify the template integer
mpls_queue_template
optional
Templates for mpls queue < mpls_queue_template > array
name
optional
Template Name string
properties
optional
Properties for the templates of mpls queue properties

mpls_queue_template

Name Description Schema
dscp_tag
optional
The DSCP Tag of the MPLS Queue 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 MPLS template integer
lan_2_wan_permitted_rate
optional
The available or allowed rate, in kbps, for LAN to WAN traffic integer
wan_2_lan_permitted_rate
optional
The available or allowed rate, in kbps, for WAN to LAN traffic integer

properties

Name Description Schema
autopath_group
optional
Autopath Group string
lan_2_wan_auto_learn
optional
LAN to WAN Auto Learn boolean
lan_2_wan_physical_rate
optional
LAN to WAN Physical Rate integer
link_type
optional
Link Type enum (internet, private_link, mpls)
wan_2_lan_auto_learn
optional
WAN to LAN Auto Learn boolean
wan_2_lan_physical_rate
optional
WAN to LAN Physical Rate integer