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

Set Service Orchestration pause state

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

Sets the orchestration pause state for a specific third-party service provider. Pausing orchestration stops tunnel building and modification. Resuming adds all associated appliances to the pending sync list.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
required
≥ 1

Unique identifier of the third-party service provider. Obtained from the /serviceProviders endpoint.

Body Params

Pause state configuration object containing the desired orchestration state.

Orchestration pause state configuration for a third-party service provider.

boolean
required
Defaults to false

Orchestration pause state. True stops tunnel operations; false resumes and triggers appliance sync.

Responses
204

Successfully updated the pause orchestration state. The operation is logged in system actions.

401

Unauthorized - Authentication credentials are missing or invalid.

403

Forbidden - User does not have READ_WRITE permission required for this operation.

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?