API Reference

Zones

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

User Agents

List user agents

zones.user_agents.list(strzone_id, UserAgentListParams**kwargs) -> UserAgentListResponse

GET/zones/{zoneId}/user-agents

Get user agent

zones.user_agents.retrieve(strid, UserAgentRetrieveParams**kwargs) -> UserAgent

GET/zones/{zoneId}/user-agents/{id}

ModelsExpand Collapse

class UserAgent: …

A User Agent represents a user agent (browser, desktop app, CLI tool) that can initiate user sessions via OAuth 2.0 Dynamic Client Registration.

id: str

Unique identifier of the user agent

created_at: datetime

Entity creation timestamp

formatdate-time

identifier: str

User agent identifier (serves as OAuth client_id). Format: ua:{sha256_hash}

name: str

Human-readable name

minLength1

maxLength255

organization_id: str

Organization that owns this user agent

slug: str

URL-safe identifier, unique within the zone

minLength1

maxLength63

updated_at: datetime

Entity update timestamp

formatdate-time

zone_id: str

Zone this user agent belongs to