Skip to content

List visible profiles

GET
/api/v1/profiles

Returns the profiles visible to the authenticated API key owner.

Profiles visible to the authenticated user.

object
profiles
required
Array<object>
object
id
required

Profile identifier.

string
fleet_id

Primary fleet identifier when one is available.

string
fleet_ids
required

All fleet identifiers assigned to the profile.

Array<string>
fleet_name

Human-readable name of the primary fleet.

string
name
required

Profile name.

string
description

Optional profile description.

string
latest_revision
required

Latest known profile revision.

integer
config_hash

Hash of the latest configuration revision when available.

string
created_at
required

UTC timestamp string returned by the current API implementation.

string
Examples

Example response

{
"profiles": [
{
"id": "a8ce71df-4c80-4d45-919a-bfd474a4d724",
"fleet_id": "fleet-primary",
"fleet_ids": [
"fleet-primary",
"fleet-secondary"
],
"fleet_name": "Primary Fleet",
"name": "Production Base",
"description": "Base image for production devices.",
"latest_revision": 12,
"config_hash": "b7b98f7c4cf1a9dcbf8a1a5a35da1431f34a9d48973026e5f86f4cc6b6d5d7dd",
"created_at": "2026-03-18 12:00:00"
}
]
}

Missing or invalid API key.

object
error
required
string
Examples

Missing API key

{
"error": "API key required"
}