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

Answers the rules that ask visitors for a login, their users and the `version` every save sends back.
A password is never part of this answer.

```http
GET /api/corestack/sites/{site}/http-auth
```

- Scope: `read`
- Two-factor: required on your account (all)
- Rate limit: 60 a minute
- Try it in the console: on

## Path parameters

- `site` (integer, required): The id of a site row. A website's production site and each of its environments has its own id. Digits only.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/corestack/sites/1042/http-auth \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/corestack/sites/1042/http-auth');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/http-auth', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/corestack/sites/1042/http-auth",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The HTTP authentication set.

```json
{
  "apply": {
    "applied_at": "2026-11-06T15:01:10Z",
    "detail": {
      "credentials": "verified"
    },
    "error": null,
    "operation": null,
    "state": "applied",
    "state_label": "Applied"
  },
  "bypass_corefinity": 1,
  "bypass_ips": [],
  "default_for_role": true,
  "enabled": true,
  "limits": {
    "prefix_max": 200,
    "rules_max": 20,
    "users_per_rule_max": 10
  },
  "note": "Passwords are stored encrypted and shown only when you reveal them; every reveal is recorded.",
  "rules": [
    {
      "enabled": true,
      "id": 51,
      "path_prefix": null,
      "sort": 0,
      "users": [
        {
          "created_at": "2026-11-04T10:00:00Z",
          "id": 71,
          "password_set": true,
          "revealed_at": "2026-11-05T11:00:00Z",
          "username": "client"
        }
      ]
    },
    {
      "enabled": true,
      "id": 52,
      "path_prefix": "/wp-admin/",
      "sort": 1,
      "users": [
        {
          "created_at": "2026-11-04T10:00:00Z",
          "id": 72,
          "password_set": true,
          "revealed_at": null,
          "username": "editor"
        }
      ]
    }
  ],
  "version": 4
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope (`scope_required`, with the `scope` to use), your company requires two-factor authentication and you have not set it up, or your account has no company that can use Managed Clusters, for example because the company was closed (`company_unavailable` or `company_not_enabled`, whichever the route checks first). For Managed Clusters routes; any other route uses `ForbiddenScopeOrTwoFactor`.

```json
{
  "code": "company_unavailable",
  "message": "Your company is unavailable.",
  "reason": "company_unavailable"
}
```

### 404 The id does not exist, or it is something you cannot see. Both answer the same body.

```json
{
  "message": "Not found."
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `company_unavailable` | Your company is unavailable. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 403 | `two_factor_required` | Turn on two-factor on your account, then send again. |
| 404 |  | Check the id. You see only what your account can reach. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Password protection](https://docs.corefinity.com/guides/sites/access-and-security/password-protection.md)
- MCP tool: [`corestack_http_auth_get`](https://docs.corefinity.com/mcp/tools/corestack_http_auth_get.md)
