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

Set AWS Transit Gateway Network Manager orchestration pause state

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

Sets the pause/resume state for AWS Transit Gateway Network Manager orchestration. When paused (true), automatic orchestration operations are suspended and all appliances are added to pending list. When resumed (false), orchestration resumes, appliances are added to pending list, and a full synchronization is triggered. This action is logged in the audit trail with details about whether orchestration was paused or resumed.

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

JSON object containing the desired pause state for AWS TGNM orchestration. The 'paused' field is required and must be a boolean value.

Represents the pause/resume state for AWS Transit Gateway Network Manager orchestration. Controls whether automatic synchronization and configuration updates to AWS TGNM resources are active.

boolean
required
Defaults to false

Indicates whether AWS TGNM orchestration is paused. When true, automatic orchestration is suspended. When false, orchestration is active and syncs with AWS resources.

Responses
204

Successfully updated the pause orchestration state. No content returned. When paused, all appliances are marked pending with 'Pause orchestration enabled' message. When resumed, appliances are marked pending and a full sync is triggered.

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?