---
title: "List all sites with their dotAuth status"
method: GET
path: "/api/v1/dotauth/sites"
tags: ["dotAuth"]
---

# List all sites with their dotAuth status

`GET /api/v1/dotauth/sites`

## Request

- Base URL: `https://docs.anzworldline-solutions.com.au`
- URL: `https://docs.anzworldline-solutions.com.au/api/v1/dotauth/sites`
- Auth: none declared
- TypeScript: <https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/docs/api/v1/dotauth/sites/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the SYSTEM_HOST (global default) status plus a per-site list indicating whether each site has its own OAuth/SAML configuration, inherits from the system default, or is unconfigured.

## Response `200`

Sites retrieved successfully

- ResponseEntityDotAuthSitesView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` DotAuthSitesView
    - `system` SystemView
      - `configured` boolean
      - `protocol` 'OAUTH' | 'SAML'
      - `headlessConfigured` boolean
    - `sites` SiteRowView[]
      - `hostId` string
      - `hostName` string
      - `status` 'SITE_OVERRIDE' | 'INHERITED' | 'NOT_CONFIGURED'
      - `protocol` 'OAUTH' | 'SAML'
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

## Other responses

- `401`: Authentication required
- `403`: User does not have permission to access dotAuth
- `500`: Internal server error

## Changes

- **2026-10-30** `4fd8e917d458`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/changes/api/v1/dotauth/sites/get.md)

---

[API](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api.md) - [All operations](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/revisions/4fd8e917d458?raw)