Validate a preconfiguration without saving

post

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

Validates the provided preconfiguration data without persisting it. Use this endpoint to verify YAML configuration syntax, field types, and serial number format before creating or updating a preconfiguration. Validates configData (base64-encoded YAML) and serialNum format only; name is not required for validation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Preconfiguration object to validate. Only configData and serialNum are validated; name and other fields are optional.

Request body for validating a preconfiguration without saving. Validates configData YAML syntax/schema and serialNum format. Use this endpoint to verify configuration before create/update operations.

configData

string

required

Base64-encoded YAML configuration string to validate. Must be valid YAML following the preconfiguration schema. Decoded and parsed to verify syntax, field names, and value types.

serialNum

string

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

Optional serial number to validate format. If provided and non-empty, must be exactly 12 hexadecimal digits without dashes (normalized form).

name

string

Optional preconfiguration name. Not validated by this endpoint but can be included for completeness.

tag

string

Optional tag (site name). Not validated by this endpoint but can be included for completeness.

comment

string

Optional comment. Not validated by this endpoint but can be included for completeness.

autoApply

boolean

Defaults to false

Optional auto-apply flag. Not validated by this endpoint but can be included for completeness.

integer

Optional preconfiguration ID. Not validated by this endpoint but can be included for completeness.

Responses

200

Preconfiguration is valid. Returns empty response body on successful validation.

Language

Loading…

Response

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

application/json

400Validation failed. Response body contains the specific error message.