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

Find matching preconfiguration by serial or tag

post
http://127.0.0.1:8080/gms/appliance/preconfiguration/findMatch

Searches for a preconfiguration that matches the provided serial number or tag. The matching is performed using an OR condition: matches on serial_num if non-empty, OR on tag if non-empty. Returns the first matching preconfiguration with base64-encoded configData.

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

Object containing serial and/or tag to match against stored preconfigurations.

Request body for finding a matching preconfiguration. At least one of serial or tag should be provided. The API performs an OR match: returns a preconfiguration if either the serial matches the serialNum field OR the tag matches the tag field.

string
^[0-9A-Fa-f]{12}$

Appliance serial number to match against stored preconfigurations. Must be 12 hexadecimal digits without dashes (normalized form). Takes precedence in matching if both serial and tag are provided.

string

Tag (site name) to match against stored preconfigurations. Used as a secondary match criterion if serial does not match or is not provided.

Responses

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?