Skip to content

service

Overview

This resource gives service related options

Version information

Version : v2

URI scheme

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

Tags

  • service : Operations related to service

Paths

POST operation for service

POST /service

Description

Disables the SD-WAN Service

Parameters

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

Responses

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

  • service

Get operation for service

GET /service

Description

Use this operation to get SD-WAN Service status

Responses

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

  • service

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

message

Message for the action request

Type : string

service_delete_success_schema

Name Schema
service
optional
service

service

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

service_post_success_schema

Name Schema
service
optional
service

service

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

service_put_success_schema

Name Schema
service
optional
service

service

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

service_response_schema

Type : < service_response_schema > array

service_response_schema

Name Schema
message
optional
message
service_state
optional
service_state

service_state

Service state

Type : enum (enabled, disabled)