get
https://hub.xyte.io/core/v1/organization/models/
Retrieve a single device model your organization can access, including the parameters and commands it supports. Only published models your organization can access are returned.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Returns a single device model your organization can access, including the parameters and commands it supports. Only published models your organization can access are returned.
Authorization
This endpoint requires Authorization.
Path Parameters
| Key | Type | Description | Required |
|---|---|---|---|
| id | String | Unique identifier of the model. | Yes |
Response
| 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. | |
| name | String | Human-readable parameter label. | |
| type | String | Parameter type: text, textarea, password, number, or file. | |
| required | Bool | Whether the parameter must be provided. | |
| commands | Array | The active commands the model supports. | |
| id | String | Unique identifier of the command. | |
| name | String | Internal command name. | |
| friendly_name | String | Human-readable command name. | |
| custom_fields | Array | The command's custom field definitions (arguments the command accepts). | |
| with_file | Bool | Whether the command requires a file argument. |
{
"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 }
],
"commands": [
{
"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"name": "reboot",
"friendly_name": "Reboot device",
"custom_fields": [{ "name": "delay", "type": "number" }],
"with_file": false
}
]
}Errors
| Status | Description |
|---|---|
| 401 | Missing or invalid Authorization header. |
| 404 | Model not found or not accessible to your organization. |
