Update an existing appliance preconfiguration

put

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

Updates an existing preconfiguration identified by preconfigId. The update replaces all fields and resets the apply status (taskStatus, completionStatus, result, etc.) to their initial state. The configData must be a valid base64-encoded YAML string.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

preconfigId

integer

required

≥ 1

Unique identifier of the preconfiguration to update. Must reference an existing preconfiguration.

Body Params

Updated preconfiguration object. All fields from the original are replaced. The name and configData fields are required.

Request body for updating an existing appliance preconfiguration. Replaces all fields of the target preconfiguration and resets apply status.

name

string

required

length ≥ 1

Updated name for the preconfiguration. Required field, cannot be empty.

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 (e.g., 000011112222). Set to empty string to clear.

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.

integer

Preconfiguration ID. Optional in request body as the preconfigId query parameter takes precedence.

Responses

200

Preconfiguration updated successfully. The apply status fields (taskStatus, completionStatus, starttime, endtime, result, guid, nePk) are reset to initial values.

Language

Loading…

Response

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

application/json

400Bad request due to validation errors.

404Preconfiguration not found for the specified preconfigId.

500Internal server error during preconfiguration update.