Create a new appliance preconfiguration

post

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

Creates a new preconfiguration that defines YAML-based settings for appliance provisioning. The configuration is stored and can be applied to appliances during discovery or after management. The configData must be a valid base64-encoded YAML string following the preconfiguration schema.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Preconfiguration object to create. The configData field must contain base64-encoded YAML configuration.

Request body for creating a new appliance preconfiguration. Used to define YAML-based settings that can be applied to appliances.

name

string

required

length ≥ 1

Unique name for the preconfiguration. Required field used to identify this configuration.

configData

string

required

Base64-encoded YAML configuration string. Must be valid YAML following the preconfiguration schema. Use GET /gms/appliance/preconfiguration/default to retrieve a template.

serialNum

string

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

Serial number for matching appliances. Must be exactly 12 hexadecimal digits without dashes (normalized form). Used with autoApply for automatic configuration.

tag

string

Tag (site name) for matching appliances during auto-discovery. Used when serialNum is not specified or as a fallback match.

comment

string

Optional user-provided description or notes about this preconfiguration.

autoApply

boolean

Defaults to false

When true, automatically applies this preconfiguration to matching appliances (by serialNum or tag) during discovery. Default is false.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Preconfiguration created successfully. Returns the ID of the newly created preconfiguration.

400Bad request due to validation errors in the request body.

500Internal server error during preconfiguration creation.