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

Update REST API configuration for Orchestrator-EdgeConnect communication

post
http://127.0.0.1:8080/restApiConfig

Updates Orchestrator-to-EdgeConnect communication settings. Changes are persisted to gms_config database table, cached in memory, and logged to audit trail with action 'Update REST API config'.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Configuration object for portal communication settings. The communicateWithApplianceViaPortal property defaults to true if omitted.

Configuration object for updating Orchestrator-to-EdgeConnect communication settings. Stored in gms_config table with resource_base '/restApiConfig'.

boolean
Defaults to true

When true, Orchestrator routes EdgeConnect API calls through Cloud Portal WebSocket. When false, uses direct REST communication.

Responses
204

Configuration updated successfully. The change is persisted to database, cached in memory, and logged to system audit trail.

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

Did this page help you?