Skip to content

internet_service

Overview

API to add, delete, get, modify Internet Services

Version information

Version : v2

URI scheme

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

Tags

  • internet_service : Operations related to internet_service

Paths

POST operation for internet_service

POST /internet_service

Description

Use this operation to add Intranet services

Responses

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

  • internet_service

Get operation for internet_service

GET /internet_service

Description

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

Responses

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

  • internet_service

PUT operation for internet_service

PUT /internet_service

Description

Use this operation to modify Intranet services

Parameters

Type Name Schema
Body body
optional
internet_service_request_schema

Responses

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

Consumes

  • application/json

Produces

  • application/json

Tags

  • internet_service

DELETE operation for internet_service

DELETE /internet_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 internet_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

  • internet_service

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

id

Auto-generated ID to uniquely identify internet service

Type : integer

internet_service

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

internet_service_delete_success_schema

Name Schema
internet_service
optional
internet_service

internet_service

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

internet_service_post_success_schema

Name Schema
internet_service
optional
internet_service

internet_service

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

internet_service_put_success_schema

Name Schema
internet_service
optional
internet_service

internet_service

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

internet_service_request_schema

Name Schema
internet_service
optional
internet_service

internet_service_response_schema

Type : < internet_service_response_schema > array

internet_service_response_schema

Name Schema
id
optional
id
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

Internet Service Properties

Name Description Schema
default_route_cost
optional
The route cost, 1-65534, that will be used for the default internet route added to this appliance integer
default_set
optional
The name of the Default Set that will be used to populate rules for the Service on the Site. Pass to set as the value 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
export_default_routes
optional
If enabled, the default route for the Internet Service, 0.0.0.0/0, will be exported to other Sites if WAN-to-WAN Forwarding has been enabled boolean
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

site_name

Site Name

Type : string