---
title: "Get the dotAuth configuration for a site"
method: GET
path: "/api/v1/dotauth/sites/{hostId}"
tags: ["dotAuth"]
---

# Get the dotAuth configuration for a site

`GET /api/v1/dotauth/sites/{hostId}`

## Request

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

Returns the protocol-specific configuration stored for the given hostId. Use the sentinel "SYSTEM_HOST" for the global default. When the host has no row of its own and the system default is configured, the response carries inherited=true and values holds the system defaults. Hidden secrets (e.g. clientSecret, privateKey) are masked as "****".

## Path parameters

- `hostId` string, required

## Response `200`

Configuration retrieved successfully

- ResponseEntityDotAuthConfigView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` DotAuthConfigView
    - `hostId` string
    - `hostName` string
    - `protocol` 'OAUTH' | 'SAML'
    - `configured` boolean
    - `inherited` boolean
    - `values` object
    - `headlessValues` object
  - `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 read this site
- `404`: Site not found
- `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/:hostId/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)