v62

latestOpenAPI 3.1.0Dual (AGPL3.0, Commercial License Available)raw.githubusercontent.com2026-08-03211303932.5 KB
Credentials

List all Credentials

Returns all credentials in the authenticated user's organization. Optionally filter by type (e.g. ?type=SnmpV2c).

get/api/v1/credentials

Query parameters

type'SnmpV1' | 'SnmpV2c' | 'SnmpV3' | 'DockerProxy' | 'DockerSocket' | 'PodmanProxy' | 'PodmanSocket' | 'UnifiApiKey' | 'UnifiLocalAdmin'

Filter by credential type (e.g. SnmpV2c, DockerProxy).

group_by'created_at' | 'name' | 'updated_at'

Primary ordering field (used for grouping). Always sorts ASC to keep groups together.

order_by'created_at' | 'name' | 'updated_at'

Secondary ordering field (sorting within groups or standalone sort).

order_direction'asc' | 'desc'

Direction for ORDER BY clauses.

Direction for order_by field (group_by always uses ASC).

limitinteger nullable

Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.

offsetinteger nullable

Number of results to skip. Default: 0.

Response

List of credentials

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "meta": {
    "api_version": 1,
    "pagination": {
      "has_more": true,
      "limit": 50,
      "offset": 0,
      "total_count": 142
    },
    "server_version": "0.17.7"
  }
}