Skip to content

intranet_service

Overview

API to add, delete, get, modify Intranet Services

Version information

Version : v2

URI scheme

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

Tags

  • intranet_service : Operations related to intranet_service

Paths

POST operation for intranet_service

POST /intranet_service

Description

Use this operation to add Intranet services

Parameters

Type Name Schema
Body body
optional
intranet_service_request_schema

Responses

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

  • intranet_service

Get operation for intranet_service

GET /intranet_service

Description

Use this operation to get the list of Intranet Services with basic settings

Responses

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

  • intranet_service

PUT operation for intranet_service

PUT /intranet_service

Description

Use this operation to modify Intranet services

Responses

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

  • intranet_service

DELETE operation for intranet_service

DELETE /intranet_service/{deletePathParam}

Description

Use this operation to delete Intranet services

Parameters

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

Responses

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

  • intranet_service

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

id

Auto-generated ID to uniquely identify intranet service

Type : integer

intranet_service

Name Schema
id
optional
id
intranet_service_name
optional
intranet_service_name
package_name
optional
package_name
properties
optional
properties
site_name
optional
site_name

intranet_service_delete_success_schema

Name Schema
intranet_service
optional
intranet_service

intranet_service

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

intranet_service_name

The name for this intranet service

Type : string

intranet_service_post_success_schema

Name Schema
intranet_service
optional
intranet_service

intranet_service

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

intranet_service_put_success_schema

Name Schema
intranet_service
optional
intranet_service

intranet_service

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

intranet_service_request_schema

Name Schema
intranet_service
optional
intranet_service

intranet_service_response_schema

Type : < intranet_service_response_schema > array

intranet_service_response_schema

Name Schema
id
optional
id
intranet_service_name
optional
intranet_service_name
package_name
optional
package_name
properties
optional
properties
site_name
optional
site_name

package_name

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

Type : string

properties

Intranet Service Properties

Name Description Schema
default_set
optional
The name of the Default Set that will be used to populate rules for the Service on the Site string
enable_primary_reclaim
optional
If enabled, the (use=primary) Usage associated with this service on a WAN Link will forcefully reclaim status as the active service on that WAN Link boolean
firewall_zone
optional
The firewall zone string
ignore_wanlink_status
optional
If enabled, packets destined for this service will still choose this service even if all WAN Links for this service are unavailable boolean
intranet_service_in_use
optional
The type of SaaS service associated with this intranet service enum (none, saas_gateway_service, azure_virtual_wan)

site_name

Site Name

Type : string