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

Remove an appliance from an overlay

delete
http://127.0.0.1:8080/gms/overlays/association

Removes a single appliance from a specified overlay. The appliance must exist in the overlay. Automatically removes hub designations when the appliance is unassociated and logs the action for audit purposes.

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

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

string
required
^\d+\.NE$

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

Responses
204

Appliance successfully removed from the overlay. No content returned.

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ_WRITE permission

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?