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

Install or upgrade SSE connector on an appliance

post
http://127.0.0.1:8080/thirdPartyServices/sse/connector

Initiates connector download and/or installation on a target appliance. Requires active Axis subscription, appliance version 9.7.0.0+, router mode, and veth interface configured. Returns a clientKey for polling asynchronous operation status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

Body Params

Request body for installing or downloading SSE connector on an appliance.

options
array of strings
required
length ≥ 1

List of actions to perform. 'download' fetches the image from portal/orchestrator; 'install' installs the connector. Can include both.

options*
Allowed:
string
^\d+\.\d+\.\d+$

Connector image version. Required when 'download' is in options. Format: '<x.y.z>'.

Responses

401

Unauthorized - Authentication required or insufficient permissions (READ_WRITE role needed)

500

Internal Server Error - Failed to communicate with Axis management or appliance

Updated about 12 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 12 hours ago

Did this page help you?