HomeGuidesAPI Reference
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community
  1. Orchestrator REST APIs
  2. thirdPartyServices

Create or update a third-party service provider

post
http://127.0.0.1:8080/thirdPartyServices/serviceOrchestration/serviceProviders

Creates a new service provider for Service Orchestration when serviceId is omitted, or updates an existing provider when serviceId is specified. On creation, bioBreakout is automatically enabled and default IPSLA settings are generated. Requires READ_WRITE role authorization.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^[0-9]+$

Numeric ID of service provider for update operations. Omit this parameter to create a new provider.

Body Params

Service provider configuration object. For creation, serviceName and servicePrefix are required. For updates, only fields to be modified need to be included.

Configuration entry for a third-party service provider in Service Orchestration. Used to integrate cloud security services like Zscaler, Palo Alto, and Netskope with SD-WAN appliances.

string
required
length between 1 and 255

Human-readable display name of the service provider. Used in UI and action logs. Must be unique across all providers.

string
required
^[a-z0-9_-]+$

Short prefix used for generating pass-through tunnel aliases and BIO policy names. Should be lowercase alphanumeric without spaces.

string

Base64-encoded icon image data (PNG, JPG, etc.) for the service provider. Maximum size: 20MB. Used in UI displays.

integer
enum
Defaults to 1

Business Intent Overlay (BIO) breakout feature. When enabled (1), traffic is steered through the third-party service. Auto-set to 1 on new provider creation.

Allowed:
integer
enum
Defaults to 0

Orchestration pause status. When paused, tunnel configuration changes are not applied to appliances.

Allowed:
string | null

JSON-encoded array of interface label breakout configuration. Format: [[primary_labels], [backup_labels]]. Labels define which WAN interfaces are used for tunnels.

string | null

JSON-encoded IPSec tunnel settings including IKE version, encryption algorithms, DPD settings, and authentication. Applied to all tunnels for this provider.

string | null

JSON-encoded IP SLA monitoring configuration for health-checking tunnels to this provider. Default settings auto-generated on creation.

Responses

Updated about 11 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 11 hours ago

Did this page help you?