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

Create or update appliance-to-region associations

post
http://127.0.0.1:8080/regions/appliances

Associates one or more appliances with specified regions. If an appliance is moved from one custom region to another, it will be removed from overlay external hub lists and associated connector interfaces will be cleared.

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

Array of appliance-to-region association objects. Each object must contain nePk and regionId.

Array of appliance-to-region associations to create or update.

Single appliance-to-region association for POST request.

string
required
^\d+\.NE$

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

string
required
^\d+$

Region ID to associate with the appliance (passed as string, parsed as integer). Must reference an existing region. Region 0 is the default region.

Responses
204

Region associations created/updated successfully. No content returned.

401

Unauthorized. Authentication credentials missing or invalid.

403

Forbidden. User lacks READ_WRITE permission for this resource.

500

Internal Server Error. An unexpected error occurred while processing the request.

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

Did this page help you?