---
title: "corestack_http_auth_get"
url: https://docs.corefinity.com/mcp/tools/corestack_http_auth_get
type: tool
last_updated: 2026-11-13
feature: http-auth
related:
  - https://docs.corefinity.com/api/reference/access/get-site-http-auth.md
  - https://docs.corefinity.com/guides/sites/access-and-security/password-protection.md
---
# corestack_http_auth_get

**HTTP authentication.** A row's HTTP authentication: whether the whole environment is protected, the protected paths with their logins (never the passwords), and the set's version — which corestack_http_auth_update needs. Scope: read.

- Scope: `read`
- Runs as a task: no

## When to use it

A row's HTTP authentication: whether the whole environment is protected, the protected paths with their logins (never the passwords), and the set's version — which corestack_http_auth_update needs.

## Inputs

- `site_id` (integer, ≥ 1, required): Any row: the site or one of its environments.

### Input schema

```json
{
  "additionalProperties": false,
  "properties": {
    "site_id": {
      "description": "Any row: the site or one of its environments.",
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "site_id"
  ],
  "type": "object"
}
```

## Refusals

- The refusals every tool can answer: `invalid_arguments`, `tenant_mismatch`, `scope_required`, `pin_refused`, `rate_limited`, `temporarily_unavailable`, `internal_error` (corestack://guides/how-this-server-works).

## Example

```json
{
  "name": "corestack_http_auth_get",
  "arguments": {
    "site_id": 4211
  }
}
```

## The answer

`{enabled, rules[], version, apply, note, …}` — never a password. `apply.state` is `applying`, `failed` or `applied`;
`apply.detail.credentials` says whether the last change's logins were checked: `pending` while it runs, `verified`,
`unverified` (the check failed), or `unchecked` — saved, but the check could not run (the site answered with its
maintenance page). With `unchecked`, `apply.detail.credentials_note` is the sentence the Control Panel shows: "Saved. We
have not been able to check it yet: open the site to confirm the login prompt appears." When `apply.state` is `failed`,
`apply.error` says why in the Control Panel's words — for example, that the environment does not hold the saved
passwords; retrying that change (corestack_operation_retry, the failed operation from corestack_site_operations_list)
writes them again.

## Prompt

```text
Using the Corefinity MCP server, call corestack_http_auth_get with site_id 4211. (HTTP authentication.) Tell me what it returned.
```

## The same task elsewhere

- Endpoint: [GET /api/corestack/sites/{site}/http-auth](https://docs.corefinity.com/api/reference/access/get-site-http-auth.md)
- Guide: [Password protection](https://docs.corefinity.com/guides/sites/access-and-security/password-protection.md)
