Skip to content

saas_gateway_service

Overview

API to add, delete, get, modify saas gateway service objects

Version information

Version : v2

URI scheme

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

Tags

  • saas_gateway_service : Operations related to saas_gateway_service

Paths

POST operation for saas_gateway_service

POST /saas_gateway_service

Description

Use this operation to add saas gateway service objects

Parameters

Type Name Schema
Body body
optional
saas_gateway_service_request_schema

Responses

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

  • saas_gateway_service

Get operation for saas_gateway_service

GET /saas_gateway_service

Description

Use this operation to get the saas gateway service objects

Responses

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

  • saas_gateway_service

PUT operation for saas_gateway_service

PUT /saas_gateway_service

Description

Use this operation to modify saas gateway service objects

Responses

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

  • saas_gateway_service

DELETE operation for saas_gateway_service

DELETE /saas_gateway_service/{deletePathParam}

Description

Use this operation to delete saas gateway service 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 saas_gateway_service_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

  • saas_gateway_service

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

external_nat

If enabled, the nat rule is configured externally outside SD WAN appliance

Type : boolean

id

Auto-generated ID to uniquely identify saas gateway service object

Type : integer

lan_object_ip

LAN Object IP Address with a prefix

Type : string

package_name

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

Type : string

primary_pop

The code for the primary pop

Type : string

saas_gateway_application_object

Saas gateway application object

Type : < saas_gateway_application_object > array

saas_gateway_application_object

Name Description Schema
application_match_name
optional
application Match Name. (A valid application object name or ) string
id
optional
Auto-generated ID to uniquely identify the saas gateway service application object integer

saas_gateway_service

Name Schema
external_nat
optional
external_nat
id
optional
id
lan_object_ip
optional
lan_object_ip
package_name
optional
package_name
primary_pop
optional
primary_pop
saas_gateway_application_object
optional
saas_gateway_application_object
saas_gateway_wan_link_usage
optional
saas_gateway_wan_link_usage
saas_service_id
optional
saas_service_id
saas_service_state
optional
saas_service_state
secondary_pop
optional
secondary_pop
site_name
optional
site_name
subscription_bandwidth
optional
subscription_bandwidth

saas_gateway_service_delete_success_schema

Name Schema
saas_gateway_service
optional
saas_gateway_service

saas_gateway_service

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

saas_gateway_service_post_success_schema

Name Schema
saas_gateway_service
optional
saas_gateway_service

saas_gateway_service

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

saas_gateway_service_put_success_schema

Name Schema
saas_gateway_service
optional
saas_gateway_service

saas_gateway_service

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

saas_gateway_service_request_schema

Name Schema
saas_gateway_service
optional
saas_gateway_service

saas_gateway_service_response_schema

Type : < saas_gateway_service_response_schema > array

saas_gateway_service_response_schema

Name Schema
external_nat
optional
external_nat
id
optional
id
lan_object_ip
optional
lan_object_ip
package_name
optional
package_name
primary_pop
optional
primary_pop
saas_gateway_application_object
optional
saas_gateway_application_object
saas_gateway_wan_link_usage
optional
saas_gateway_wan_link_usage
saas_service_id
optional
saas_service_id
saas_service_state
optional
saas_service_state
secondary_pop
optional
secondary_pop
site_name
optional
site_name
subscription_bandwidth
optional
subscription_bandwidth

saas_gateway_wan_link_usage

Saas Gateway Servic WAN Link usage

Type : < saas_gateway_wan_link_usage > array

saas_gateway_wan_link_usage

Name Description Schema
id
optional
Auto-generated ID to uniquely identify the saas wan link usage integer
lan_to_wan_reserved_bandwidth_kbps
optional
Reserved Bandwidth in the LAN to WAN direction integer
wan_link_index
optional
WAN link index used for WAN Link Saas Tap interface mapping integer
wan_link_name
optional
WAN Link Name string
wan_link_type
optional
WAN Link Type string
wan_to_lan_reserved_bandwidth_kbps
optional
Reserved Bandwidth in the WAN to LAN direction integer

saas_service_id

Saas Service Side id.

Type : integer

saas_service_state

Saas Service State.

Type : string

secondary_pop

The code for the secondary pop

Type : string

site_name

Site Name

Type : string

subscription_bandwidth

The subscribed service bandwidth for the site

Type : integer