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

Remove appliances from overlays

post
http://127.0.0.1:8080/gms/overlays/association/remove

Removes one or more appliances from specified overlays. Automatically removes hub designations from overlays when appliances are unassociated and triggers orchestration updates.

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

Array of overlay-appliance associations to remove

Array of overlay-appliance association objects to remove.

Single overlay-appliance association defining which appliance to remove from which overlay.

string
required
^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE'.

string
required
^\d+$

Numeric ID of the overlay to remove the appliance from. Must be a valid existing overlay ID.

Responses
204

Appliances successfully removed from overlays. No content returned.

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ_WRITE permission

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?