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

Add appliances to overlays

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

Associates one or more appliances with specified overlays. Validates appliances exist and meet minimum software version requirements. Automatically enables the overlay manager and adds hub appliances to overlay configurations.

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

Array of overlay-appliance associations to create

Array of overlay-appliance association objects to add. Each object specifies an appliance to associate with an overlay.

Single overlay-appliance association defining which appliance to add to 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 add the appliance to. Must be a valid existing overlay ID.

Responses
204

Appliances successfully added to overlays. No content returned.

401

Unauthorized - Authentication required or invalid credentials

403

Forbidden - User lacks READ_WRITE permission

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

Did this page help you?