HomeGuidesAPI Reference
API Reference

Retrieve appliance preconfigurations

Retrieves appliance preconfigurations with flexible filtering options. Returns different response structures based on query parameters:

  • No parameters: Returns all preconfigurations with full details including base64-encoded configData
  • preconfigId: Returns a single preconfiguration by ID
  • filter=names: Returns only preconfiguration names (lightweight)
  • filter=metadata: Returns metadata without the configData field

Note: filter and preconfigId parameters are mutually exclusive.

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

Filter type to return a subset of data. Use 'names' to retrieve only preconfiguration names, or 'metadata' to retrieve metadata (excludes configData). Cannot be used together with preconfigId.

Allowed:
integer
≥ 1

Unique identifier of a specific preconfiguration to retrieve. Returns a single preconfiguration object when specified. Cannot be used together with filter parameter.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json