Get Models

Time	Status	User Agent
Retrieving recent requests…

Overview

Returns the device models your organization can access and claim. Use this to discover which models are available and what parameters each one requires before claiming or configuring a device.

By default the full set of models your organization is allowed to see is returned. Pass edge_only=true to narrow the list to edge models — those provided by a Zabbix-partner. Only published models your organization can access are returned.

Authorization

This endpoint requires Authorization.

Query Parameters

Key	Type	Description	Required
page	Integer	Page number (default: 1).	No
per_page	Integer	Items per page (default: 100, max: 100).	No
search	String	Filter by model name or alias name (case-insensitive, partial match).	No
edge_only	Bool	When `true`, return only edge (Zabbix-partner) device models.	No

Response

Returns Paginated data of the following format for each item:

Key	Subkey	Type	Description
id		String	Unique identifier of the device model.
vendor		String	Vendor / manufacturer name.
model		String	Model name.
aliases		Array	Alternative names the model is also known by (array of strings).
parameters		Array	The custom parameters the model supports when claiming / configuring a device.
	name	String	Human-readable parameter label (the same key used by Update / Get Device `custom_parameters`).
	type	String	Parameter type: `text`, `textarea`, `password`, `number`, or `file`.
	required	Bool	Whether the parameter must be provided.

{
  "items": [
    {
      "id": "5e7b1f0a-3c2d-4e5f-9a8b-1c2d3e4f5a6b",
      "vendor": "Acme",
      "model": "Acme Sensor 100",
      "aliases": ["Acme Alpha", "Acme Beta"],
      "parameters": [
        { "name": "SNMP community", "type": "text", "required": true },
        { "name": "Port", "type": "number", "required": false }
      ]
    }
  ],
  "next_page": null
}

Errors

Status	Description
401	Missing or invalid `Authorization` header.

Overview

Authorization

Query Parameters

Response

Errors

200200