Retrieves models

GET 
https://apis.<domain>/iot/models

Authorization: http

name: bearerTokentype: httpscheme: bearerin: headerdescription: Authorization Header: `Authorization: Bearer <user_token>`

Retrieves a list of models. Due to performance concerns, data is retrieved in subsets. The API must ensure that the entire dataset is consumed either by making subsequent requests, or by increasing the subset size of the initial request.

Authorization Action:

core:models:list

Request

Query Parameters

limit integer

Possible values: >= 1 and <= 100

Default value: 10

Size of the subset to retrieve.

offset integer

Number of items to skip during retrieval.

name string

Name filter. Filtering is performed as a case-insensitive partial match.

order string

Possible values: [name, id]

Default value: id

Order type.

dir string

Possible values: [asc, desc]

Default value: desc

Order direction.

metadata object

Metadata filter. Filtering is performed matching the parameter with metadata on top level. Parameter is json.

tag string

Tag filter. Filtering is performed as a case-insensitive match.

tenant string

Possible values: <= 64 characters

Tenant filter. Used to filter models by specific tenant.

Responses

200

List of models with pagination info.

application/json

Schema

Schema

total integer
offset integer
limit integer
models object[]
Array [
id uuid
Unique model identifier.
name string
Free-form model name.
description string
Free-form model description.
metadata object
Arbitrary, object-encoded model data.
tags string[]
List of tags associated with the model.
tenants string[]
List of tenants that can access this model.
image string
URL to model image.
created_at date-time
Time when the model was created.
updated_at date-time
Time when the model was last updated.
]

Example (from schema)

{
  "total": 0,
  "offset": 0,
  "limit": 0,
  "models": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "description": "string",
      "metadata": {},
      "tags": [
        "string"
      ],
      "tenants": [
        "string"
      ],
      "image": "string",
      "created_at": "2025-01-14T09:16:36.675Z",
      "updated_at": "2025-01-14T09:16:36.675Z"
    }
  ]
}

400

Failed due to malformed query parameters.

401

Missing or invalid access token provided.

422

Database can't process request.

500

Unexpected server error.

application/json

Schema

Schema

• string byte

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://apis.<domain>/iot/models' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

https://apis.<domain>

Auth

Bearer Token

Parameters

limit — query

offset — query

name — query

order — query

---nameid

dir — query

---ascdesc

metadata — query

tag — query

tenant — query