List a zone's basic auth users
GET
/api/zones/{zoneId}/basic-auth-users
Returns all HTTP Basic Authentication users configured for the given zone. Passwords are never included in the response; only username, comment, and timestamps are returned.
Authorizations
ApiToken
Long-lived API token created via POST /api/api-tokens (returned once in plaintext).
Type
API Key (header: X-API-TOKEN)
or
JWT
JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer
Type
HTTP (bearer)
Parameters
Path Parameters
zoneId*
Zone identifier
Type
Requiredstring
Query Parameters
page
The collection page number
Type
integer
Default
1itemsPerPage
The number of items per page
Type
integer
Default
30Minimum
0Maximum
100Responses
basic-auth-user collection
JSON "totalItems": 0, "search": { "@type": "string", "template": "string", "variableRepresentation": "string", "mapping": [ { "@type": "string", "variable": "string", "property": "string", "required": true } ] }, "view": { "@id": "string", "@type": "string", "first": "string", "last": "string", "previous": "string", "next": "string" }, "member": [ { "@context": "string", "@id": "string", "@type": "string", "id": "9f8b2c1a-4d3e-4f5a-8b6c-7d8e9f0a1b2c", "zone": "https://example.com/", "username": "jdoe", "comment": "Read-only access for the analytics team", "createdAt": "2026-01-15T09:30:00+00:00", "updatedAt": "2026-01-16T14:05:00+00:00" } ]
{
}