Retrieve appliance model specifications

post

http://127.0.0.1:8080/modelSpec

Retrieves model specification data for one or more appliance models. First checks local orchestration store cache, then fetches missing data from Cloud Portal. Results are cached for future requests.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body containing model identifiers and specification keys to retrieve.

Request body for retrieving model specifications.

models

array of objects

required

length ≥ 1

List of appliance models to query. Each model requires modelName; partNum is optional for more specific lookups.

models*

Identifies an appliance model. The modelName is required; partNum is optional for more specific lookups. Values are HTML-escaped for security.

modelName

string

required

length ≥ 1

Appliance model name (e.g., 'EC-V', 'EC-XS', 'EC-M'). Required and must not be empty or null. Models with empty names are skipped during processing.

partNum

string

Optional part number for specific model variant. When provided, response key format is 'modelName_partNum'; otherwise just 'modelName'.

searchKeys

array of strings

required

length ≥ 1

List of specification keys to retrieve (e.g., 'spec.networking.ports', 'spec.hardware.memory').

searchKeys*

Dot-notation path to the specification data to retrieve.

Responses

Language

Loading…

Response

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

application/json

200Model specifications retrieved successfully. Returns requested specification data keyed by model identifier.

400Bad request due to missing or invalid parameters.

500Internal server error during model spec update or retrieval.