Skip to content

saas_service

Overview

This resource gives saas gateway service related options

Version information

Version : v2

URI scheme

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

Tags

  • saas_service : Operations related to saas_service

Paths

POST operation for saas_service

POST /saas_service

Description

Enables the SD-WAN SaaS Gateway Service

Parameters

Type Name Description Schema
Query action
required
Select if action is other that ADD enum (enable, disable)

Responses

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

Produces

  • application/json

Tags

  • saas_service

Get operation for saas_service

GET /saas_service

Description

Use this operation to get SD-WAN SaaS Gateway Service status

Responses

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

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

saas_service_delete_success_schema

Name Schema
saas_service
optional
saas_service

saas_service

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

saas_service_post_success_schema

Name Schema
saas_service
optional
saas_service

saas_service

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

saas_service_put_success_schema

Name Schema
saas_service
optional
saas_service

saas_service

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

saas_service_response_schema

Type : < saas_service_response_schema > array

saas_service_response_schema

Name Schema
saas_service_state
optional
saas_service_state

saas_service_state

SaaS service state

Type : enum (enabled, disabled)